Skip to content
Equnix Metal
show

Organizations copied!

Organizations Management. Check out the product docs to learn more about Organizations.

Retrieve organization's events copied!

GET
/organizations/{id}/events

Returns a list of events for a single organization

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve all facilities visible by the organization copied!

GET
/organizations/{id}/facilities

Returns a listing of available datacenters for the given organization

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve all devices of an organization copied!

GET
/organizations/{id}/devices

Provides a collection of devices for a given organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve organization invitations copied!

GET
/organizations/{id}/invitations

Returns all invitations in an organization.

  • Parameters
  • include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

    id
    string  (required) in path

    Organization UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create an invitation for an organization copied!

POST
/organizations/{id}/invitations

In order to add a user to an organization, they must first be invited. To invite to several projects the parameter projects_ids:[a,b,c] can be used

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    invitation
     (required) in body

    Invitation to create

    invitee

    {
        "invitee": "string",
        "message": "string",
        "roles": [
            "string"
        ],
        "projects_ids": [
            "string"
        ]
    }

Retrieve the custom metadata of an organization copied!

GET
/organizations/{id}/customdata

Provides the custom metadata stored for this organization in json format

Retrieve all operating systems visible by the organization copied!

GET
/organizations/{id}/operating-systems

Returns a listing of available operating systems for the given organization

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve all organizations copied!

GET
/organizations

Returns a list of organizations that are accessible to the current user.

  • Parameters
  • personal
    string in query

    Include, exclude or show only personal organizations.

    without_projects
    string in query

    Include, exclude or show only organizations that have no projects.

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create an organization copied!

POST
/organizations

Creates an organization.

  • Parameters
  • organization
     (required) in body

    Organization to create

    {
        "name": "string",
        "description": "string",
        "website": "string",
        "twitter": "string",
        "logo": "string",
        "address": {
            "$ref": "#\/definitions\/Address"
        },
        "billing_address": {
            "$ref": "#\/definitions\/Address"
        },
        "customdata": "object",
        "enforce_2fa_at": "string"
    }

Retrieve an organization's details copied!

GET
/organizations/{id}

Returns a single organization's details, if the user is authorized to view it.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the organization copied!

PUT
/organizations/{id}

Updates the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    organization
     (required) in body

    Organization to update

    {
        "name": "string",
        "description": "string",
        "website": "string",
        "twitter": "string",
        "logo": "string",
        "address": {
            "$ref": "#\/definitions\/Address"
        },
        "billing_address": {
            "$ref": "#\/definitions\/Address"
        },
        "customdata": "object",
        "enforce_2fa_at": "string"
    }

Delete the organization copied!

DELETE
/organizations/{id}

Deletes the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

Retrieve all payment methods of an organization copied!

GET
/organizations/{id}/payment-methods

Returns all payment methods of an organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a payment method for the given organization copied!

POST
/organizations/{id}/payment-methods

Creates a payment method.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    payment_method
     (required) in body

    Payment Method to create

    name, nonce

    {
        "name": "string",
        "nonce": "string",
        "default": "boolean"
    }

Retrieve all plans visible by the organization copied!

GET
/organizations/{id}/plans

Returns a listing of available plans for the given organization

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve all projects of an organization copied!

GET
/organizations/{id}/projects

Returns a collection of projects that belong to the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a project for the organization copied!

POST
/organizations/{id}/projects

Creates a new project for the organization

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    project
     (required) in body

    Project to create

    name

    {
        "name": "string",
        "payment_method_id": "string",
        "customdata": "object"
    }

Provides a collection of project transfer requests from or to the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide