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

Retrieve organization's events

GET
/organizations/{id}/events

Returns a list of events for a single organization

    /organizations/{id}/events
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

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

Returns a listing of available datacenters for the given organization

    /organizations/{id}/facilities
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

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

Retrieve all devices of an organization

GET
/organizations/{id}/devices

Provides a collection of devices for a given organization.

    /organizations/{id}/devices
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

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

Retrieve organization invitations

GET
/organizations/{id}/invitations

Returns all invitations in an organization.

    /organizations/{id}/invitations
  • Parameters
  • include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

    id
    string  (required) in path

    Organization UUID

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

Create an invitation for an organization

/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

    /organizations/{id}/invitations
  • 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

GET
/organizations/{id}/customdata

Provides the custom metadata stored for this organization in json format

Retrieve all operating systems visible by the organization

GET
/organizations/{id}/operating-systems

Returns a listing of available operating systems for the given organization

    /organizations/{id}/operating-systems
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

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

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

    /organizations
  • 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
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

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

Create an organization

/organizations

Creates an organization.

    /organizations
  • 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": "string",
    	"enforce_2fa_at": "string"
    } 

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

    /organizations/{id}
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

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

Update the organization

PUT
/organizations/{id}

Updates the organization.

    /organizations/{id}
  • 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": "string",
    	"enforce_2fa_at": "string"
    } 

Delete the organization

/organizations/{id}

Deletes the organization.

    /organizations/{id}
  • Parameters
  • id
    string  (required) in path

    Organization UUID

Retrieve all payment methods of an organization

GET
/organizations/{id}/payment-methods

Returns all payment methods of an organization.

    /organizations/{id}/payment-methods
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

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

Create a payment method for the given organization

/organizations/{id}/payment-methods

Creates a payment method.

    /organizations/{id}/payment-methods
  • 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"
    } 

Returns a listing of available plans for the given organization

    /organizations/{id}/plans
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

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

Retrieve all projects of an organization

GET
/organizations/{id}/projects

Returns a collection of projects that belong to the organization.

    /organizations/{id}/projects
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

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

Create a project for the organization

/organizations/{id}/projects

Creates a new project for the organization

    /organizations/{id}/projects
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    project
     (required) in body

    Project to create

    name

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

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

    /organizations/{id}/transfers
  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

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