Back to top

Organizations

Organizations Management

Retrieve all devices of an organization
GET
/organizations/{id}/devices

Provides a collection of devices for a given organization.

  • 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
  • Response  200   ok
  • {
    	"devices": [
    		{
    			"id": "string",
    			"short_id": "string",
    			"hostname": "string",
    			"description": "string",
    			"state": "string",
    			"tags": [
    				"string"
    			],
    			"image_url": "string",
    			"billing_cycle": "string",
    			"user": "string",
    			"iqn": "string",
    			"locked": "boolean",
    			"bonding_mode": "integer",
    			"created_at": "string",
    			"updated_at": "string",
    			"spot_instance": "boolean",
    			"spot_price_max": "number",
    			"termination_time": "string",
    			"customdata": "string",
    			"provisioning_percentage": "number",
    			"operating_system": {
    				"id": "string",
    				"slug": "string",
    				"name": "string",
    				"distro": "string",
    				"version": "string",
    				"provisionable_on": [
    					"string"
    				]
    			},
    			"always_pxe": "boolean",
    			"ipxe_script_url": "string",
    			"location": {
    				"cage": "string",
    				"facility": "string",
    				"rack": "string",
    				"row": "string",
    				"switch": "string"
    			},
    			"facility": {
    				"id": "string",
    				"name": "string",
    				"code": "string",
    				"features": [
    					"string"
    				],
    				"address": {
    					"$ref": "#\/definitions\/Address"
    				}
    			},
    			"plan": {
    				"id": "string",
    				"slug": "string",
    				"name": "string",
    				"description": "string",
    				"line": "string",
    				"specs": "object",
    				"pricing": "object",
    				"legacy": "boolean",
    				"class": "string",
    				"available_in": [
    					{
    						"href": "string"
    					}
    				]
    			},
    			"userdata": "string",
    			"root_password": "string",
    			"href": "string",
    			"project": {
    				"href": "string"
    			},
    			"project_lite": {
    				"href": "string"
    			},
    			"volumes": [
    				{
    					"href": "string"
    				}
    			],
    			"hardware_reservation": {
    				"href": "string"
    			},
    			"ssh_keys": [
    				{
    					"href": "string"
    				}
    			],
    			"ip_addresses": [
    				{
    					"id": "string",
    					"address_family": "integer",
    					"netmask": "string",
    					"public": "boolean",
    					"enabled": "boolean",
    					"cidr": "integer",
    					"management": "boolean",
    					"manageable": "boolean",
    					"assigned_to": {
    						"$ref": "#\/definitions\/Href"
    					},
    					"network": "string",
    					"address": "string",
    					"gateway": "string",
    					"href": "string",
    					"created_at": "string",
    					"parent_block": {
    						"$ref": "#\/definitions\/ParentBlock"
    					}
    				}
    			],
    			"provisioning_events": [
    				{
    					"id": "string",
    					"state": "string",
    					"type": "string",
    					"body": "string",
    					"relationships": "array",
    					"interpolated": "string",
    					"created_at": "string",
    					"href": "string"
    				}
    			]
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve organization invitations
/organizations/{id}/invitations

Returns all invitations in an organization.

  • 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  200   ok
  • {
    	"invitations": [
    		{
    			"id": "string",
    			"roles": [
    				"string"
    			],
    			"created_at": "string",
    			"updated_at": "string",
    			"project": {
    				"href": "string"
    			},
    			"user": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Create an invitation for an organization
GET
/organizations/{id}/invitations

In order to add a user to an organization, they must first be invited.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    invitation
     (required) in body

    Invitation to create

    invitee

    {
    	"invitee": "string",
    	"message": "string",
    	"roles": [
    		"string"
    	]
    } 
  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  201   created
  • {
    	"id": "string",
    	"roles": [
    		"string"
    	],
    	"invitee": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"invited_by": {
    		"href": "string"
    	},
    	"invitable": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve all organizations
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
    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
  • Response  200   ok
  • {
    	"organizations": [
    		{
    			"id": "string",
    			"name": "string",
    			"description": "string",
    			"website": "string",
    			"twitter": "string",
    			"logo": "string",
    			"created_at": "string",
    			"updated_at": "string",
    			"projects": [
    				{
    					"href": "string"
    				}
    			],
    			"members": [
    				{
    					"href": "string"
    				}
    			],
    			"memberships": [
    				{
    					"href": "string"
    				}
    			],
    			"address": {
    				"address": "string",
    				"address2": "string",
    				"city": "string",
    				"state": "string",
    				"zip_code": "string",
    				"country": "string",
    				"coordinates": {
    					"$ref": "#\/definitions\/Coordinates"
    				}
    			},
    			"billing_address": {
    				"address": "string",
    				"address2": "string",
    				"city": "string",
    				"state": "string",
    				"zip_code": "string",
    				"country": "string",
    				"coordinates": {
    					"$ref": "#\/definitions\/Coordinates"
    				}
    			},
    			"entitlement": {
    				"id": "string",
    				"description": "string",
    				"slug": "string",
    				"name": "string",
    				"weight": "integer",
    				"instance_quota": "object",
    				"project_quota": "integer",
    				"volume_quota": "object",
    				"ip_quota": "object",
    				"feature_access": "object",
    				"href": "string"
    			},
    			"terms": "integer",
    			"credit_amount": "number",
    			"customdata": "string"
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    } 
  • Response  401   unauthorized
Create an organization
/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": "string"
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"projects": [
    		{
    			"href": "string"
    		}
    	],
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"address": {
    		"address": "string",
    		"address2": "string",
    		"city": "string",
    		"state": "string",
    		"zip_code": "string",
    		"country": "string",
    		"coordinates": {
    			"latitude": "string",
    			"longitude": "string"
    		}
    	},
    	"billing_address": {
    		"address": "string",
    		"address2": "string",
    		"city": "string",
    		"state": "string",
    		"zip_code": "string",
    		"country": "string",
    		"coordinates": {
    			"latitude": "string",
    			"longitude": "string"
    		}
    	},
    	"entitlement": {
    		"id": "string",
    		"description": "string",
    		"slug": "string",
    		"name": "string",
    		"weight": "integer",
    		"instance_quota": "object",
    		"project_quota": "integer",
    		"volume_quota": "object",
    		"ip_quota": "object",
    		"feature_access": "object",
    		"href": "string"
    	},
    	"terms": "integer",
    	"credit_amount": "number",
    	"customdata": "string"
    } 
  • Response  401   unauthorized
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve an organization's details
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
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"projects": [
    		{
    			"href": "string"
    		}
    	],
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"address": {
    		"address": "string",
    		"address2": "string",
    		"city": "string",
    		"state": "string",
    		"zip_code": "string",
    		"country": "string",
    		"coordinates": {
    			"latitude": "string",
    			"longitude": "string"
    		}
    	},
    	"billing_address": {
    		"address": "string",
    		"address2": "string",
    		"city": "string",
    		"state": "string",
    		"zip_code": "string",
    		"country": "string",
    		"coordinates": {
    			"latitude": "string",
    			"longitude": "string"
    		}
    	},
    	"entitlement": {
    		"id": "string",
    		"description": "string",
    		"slug": "string",
    		"name": "string",
    		"weight": "integer",
    		"instance_quota": "object",
    		"project_quota": "integer",
    		"volume_quota": "object",
    		"ip_quota": "object",
    		"feature_access": "object",
    		"href": "string"
    	},
    	"terms": "integer",
    	"credit_amount": "number",
    	"customdata": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Update the organization
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": "string"
    } 
  • Response  200   ok
  • {
    	"id": "string",
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"projects": [
    		{
    			"href": "string"
    		}
    	],
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"address": {
    		"address": "string",
    		"address2": "string",
    		"city": "string",
    		"state": "string",
    		"zip_code": "string",
    		"country": "string",
    		"coordinates": {
    			"latitude": "string",
    			"longitude": "string"
    		}
    	},
    	"billing_address": {
    		"address": "string",
    		"address2": "string",
    		"city": "string",
    		"state": "string",
    		"zip_code": "string",
    		"country": "string",
    		"coordinates": {
    			"latitude": "string",
    			"longitude": "string"
    		}
    	},
    	"entitlement": {
    		"id": "string",
    		"description": "string",
    		"slug": "string",
    		"name": "string",
    		"weight": "integer",
    		"instance_quota": "object",
    		"project_quota": "integer",
    		"volume_quota": "object",
    		"ip_quota": "object",
    		"feature_access": "object",
    		"href": "string"
    	},
    	"terms": "integer",
    	"credit_amount": "number",
    	"customdata": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Delete the organization
/organizations/{id}

Deletes the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    id
    string  (required) in path

    Cage UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  404   not found
Retrieve all projects of an organization
GET
/organizations/{id}/projects

Returns a collection of projects that belong to the organization.

  • 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
  • Response  200   ok
  • {
    	"projects": [
    		{
    			"id": "string",
    			"name": "string",
    			"created_at": "string",
    			"updated_at": "string",
    			"max_devices": "object",
    			"members": [
    				{
    					"href": "string"
    				}
    			],
    			"memberships": [
    				{
    					"href": "string"
    				}
    			],
    			"network_status": "object",
    			"invitations": [
    				{
    					"href": "string"
    				}
    			],
    			"payment_method": {
    				"href": "string"
    			},
    			"devices": [
    				{
    					"href": "string"
    				}
    			],
    			"ssh_keys": [
    				{
    					"href": "string"
    				}
    			],
    			"volumes": [
    				{
    					"href": "string"
    				}
    			],
    			"bgp_config": {
    				"href": "string"
    			},
    			"customdata": "string"
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    } 
  • Response  401   unauthorized
Create a project for the organization
/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": "string"
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"name": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"max_devices": "object",
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"network_status": "object",
    	"invitations": [
    		{
    			"href": "string"
    		}
    	],
    	"payment_method": {
    		"href": "string"
    	},
    	"devices": [
    		{
    			"href": "string"
    		}
    	],
    	"ssh_keys": [
    		{
    			"href": "string"
    		}
    	],
    	"volumes": [
    		{
    			"href": "string"
    		}
    	],
    	"bgp_config": {
    		"href": "string"
    	},
    	"customdata": "string"
    } 
  • Response  401   unauthorized
  • Response  422   unprocessable entity
Retrieve all project transfer requests from or to an organization
GET
/organizations/{id}/transfers

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

  • 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
  • Response  200   ok
  • {
    	"transfers": [
    		{
    			"id": "string",
    			"created_at": "string",
    			"updated_at": "string",
    			"target_organization": {
    				"href": "string"
    			},
    			"project": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
Retrieve all payment methods of an organization
GET
/organizations/{id}/payment-methods

Returns all payment methods of an organization.

  • 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
  • Response  200   ok
  • {
    	"payment_methods": [
    		{
    			"id": "string",
    			"name": "string",
    			"type": "string",
    			"default": "boolean",
    			"created_at": "string",
    			"updated_at": "string",
    			"card_type": "string",
    			"expiration_month": "string",
    			"expiration_year": "string",
    			"cardholder_name": "string",
    			"billing_address": {
    				"street_address": "string",
    				"postal_code": "string",
    				"country_code_alpha2": "string"
    			},
    			"email": "string",
    			"created_by_user": {
    				"href": "string"
    			},
    			"organization": {
    				"href": "string"
    			},
    			"projects": [
    				{
    					"href": "string"
    				}
    			]
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  404   not found
Create a payment method for the given organization
/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"
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"name": "string",
    	"type": "string",
    	"default": "boolean",
    	"created_at": "string",
    	"updated_at": "string",
    	"card_type": "string",
    	"expiration_month": "string",
    	"expiration_year": "string",
    	"cardholder_name": "string",
    	"billing_address": {
    		"street_address": "string",
    		"postal_code": "string",
    		"country_code_alpha2": "string"
    	},
    	"email": "string",
    	"created_by_user": {
    		"href": "string"
    	},
    	"organization": {
    		"href": "string"
    	},
    	"projects": [
    		{
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve the custom metadata of an organization
GET
/organizations/{id}/customdata

Provides the custom metadata stored for this organization in json format

  • Parameters
  • id
    string  (required) in path

    Organization UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found