Equinix Metal provides a RESTful HTTP API which can be reached at https://api.equinix.com/metal/v1. This document describes the API and how to use it.
The API allows you to programmatically interact with all of your Equinix Metal resources, including devices, networks, addresses, organizations, projects, and your user account. Every feature of the Equinix Metal web interface is accessible through the API.
The API docs are generated from the Equinix Metal OpenAPI specification and are officially hosted at https://deploy.equinix.com/developers/api/metal/.
The Equinix Metal API uses a few methods to minimize network traffic and improve throughput. These parameters are not used in all API calls, but are used often enough to warrant their own section. Look for these parameters in the documentation for the API calls that support them.
Pagination is used to limit the number of results returned in a single request. The API will return a maximum of 100 results per page. To retrieve additional results, you can use the page
and per_page
query parameters.
The page
parameter is used to specify the page number. The first page is 1
. The per_page
parameter is used to specify the number of results per page. The maximum number of results differs by resource type.
Where offered, the API allows you to sort results by a specific field. To sort results use the sort_by
query parameter with the root level field name as the value. The sort_direction
parameter is used to specify the sort direction, either either asc
(ascending) or desc
(descending).
Filtering is used to limit the results returned in a single request. The API supports filtering by certain fields in the response. To filter results, you can use the field as a query parameter.
For example, to filter the IP list to only return public IPv4 addresses, you can filter by the type
field, as in the following request:
curl -H 'X-Auth-Token: my_authentication_token' \
https://api.equinix.com/metal/v1/projects/id/ips?type=public_ipv4
Only IP addresses with the type
field set to public_ipv4
will be returned.
Searching is used to find matching resources using multiple field comparissons. The API supports searching in resources that define this behavior. Currently the search parameter is only available on devices, ssh_keys, api_keys and memberships endpoints.
To search resources you can use the search
query parameter.
For resources that contain references to other resources, sucha as a Device that refers to the Project it resides in, the Equinix Metal API will returns href
values (API links) to the associated resource.
{
...
"project": {
"href": "/metal/v1/projects/f3f131c8-f302-49ef-8c44-9405022dc6dd"
}
}
If you're going need the project details, you can avoid a second API request. Specify the contained href
resources and collections that you'd like to have included in the response using the include
query parameter.
For example:
curl -H 'X-Auth-Token: my_authentication_token' \
https://api.equinix.com/metal/v1/user?include=projects
The include
parameter is generally accepted in GET
, POST
, PUT
, and PATCH
requests where href
resources are presented.
To have multiple resources include, use a comma-separated list (e.g. ?include=emails,projects,memberships
).
curl -H 'X-Auth-Token: my_authentication_token' \
https://api.equinix.com/metal/v1/user?include=emails,projects,memberships
You may also include nested associations up to three levels deep using dot notation (?include=memberships.projects
):
curl -H 'X-Auth-Token: my_authentication_token' \
https://api.equinix.com/metal/v1/user?include=memberships.projects
To exclude resources, and optimize response delivery, use the exclude
query parameter. The exclude
parameter is generally accepted in GET
, POST
, PUT
, and PATCH
requests for fields with nested object responses. When excluded, these fields will be replaced with an object that contains only an href
field.
Nearly all of the endpoints in the API require authentication. Authentication is performed by providing an authentication token (interchangeably referred to as an API key) in the X-Auth-Token
HTTP request header.
User API keys can be obtained by creating them in the Equinix Metal Portal or by using the Create a User API Key endpoint.
Project API keys can also be obtained by creating them in the Equinix Metal Portal or by using the Create a Project API Key endpoint. Project API keys are scoped to a single project and can only be used to access resources within that project.
For example, to use an authenticated API token, you would make a request like the following:
curl -H 'X-Auth-Token: my_authentication_token' \
https://api.equinix.com/metal/v1/user/api-keys
Applications can take advantage of the Equinix Metal API and API keys to perform any of the actions that can be performed in the Equinix Metal Portal. For example, you can use the API to create and manage devices, projects, and other resources.
API keys can be deleted without affecting any of the resources created with them. Access to applications using the API can be revoked by deleting the API key used to authenticate the application.
Returns all API keys for a specific project.
id required | string <uuid> Project UUID |
include | Array of strings 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. |
Array of objects (AuthToken) | |||||||||||||||||
Array
|
{- "api_keys": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "read_only": true,
- "token": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "default_organization_id": "7498eaa8-62af-4757-81e0-959250fc9cd5",
- "default_project_id": "1226a120-3a85-4fe0-bba2-cdfc7af0d81b",
- "email": "string",
- "emails": [
- {
- "href": "string"
}
], - "first_name": "string",
- "fraud_score": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_login_at": "2019-08-24T14:15:22Z",
- "last_name": "string",
- "max_organizations": 0,
- "max_projects": 0,
- "phone_number": "string",
- "short_id": "string",
- "timezone": "string",
- "two_factor_auth": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Creates an API key for a project.
id required | string <uuid> Project UUID |
include | Array of strings 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. |
API Key to create
description | string |
read_only | boolean |
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Available only for API keys | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (AuthToken_project) Available only for project tokens | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
read_only | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
token | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (AuthToken_user) Available only for user tokens | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "description": "string",
- "read_only": true
}
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "read_only": true,
- "token": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "default_organization_id": "7498eaa8-62af-4757-81e0-959250fc9cd5",
- "default_project_id": "1226a120-3a85-4fe0-bba2-cdfc7af0d81b",
- "email": "string",
- "emails": [
- {
- "href": "string"
}
], - "first_name": "string",
- "fraud_score": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_login_at": "2019-08-24T14:15:22Z",
- "last_name": "string",
- "max_organizations": 0,
- "max_projects": 0,
- "phone_number": "string",
- "short_id": "string",
- "timezone": "string",
- "two_factor_auth": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Returns all API keys for the current user.
search | string Search by description |
include | Array of strings 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. |
Array of objects (AuthToken) | |||||||||||||||||
Array
|
{- "api_keys": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "read_only": true,
- "token": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "default_organization_id": "7498eaa8-62af-4757-81e0-959250fc9cd5",
- "default_project_id": "1226a120-3a85-4fe0-bba2-cdfc7af0d81b",
- "email": "string",
- "emails": [
- {
- "href": "string"
}
], - "first_name": "string",
- "fraud_score": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_login_at": "2019-08-24T14:15:22Z",
- "last_name": "string",
- "max_organizations": 0,
- "max_projects": 0,
- "phone_number": "string",
- "short_id": "string",
- "timezone": "string",
- "two_factor_auth": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Creates a API key for the current user.
include | Array of strings 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. |
API key to create
description | string |
read_only | boolean |
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Available only for API keys | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (AuthToken_project) Available only for project tokens | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
read_only | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
token | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (AuthToken_user) Available only for user tokens | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "description": "string",
- "read_only": true
}
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "read_only": true,
- "token": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "default_organization_id": "7498eaa8-62af-4757-81e0-959250fc9cd5",
- "default_project_id": "1226a120-3a85-4fe0-bba2-cdfc7af0d81b",
- "email": "string",
- "emails": [
- {
- "href": "string"
}
], - "first_name": "string",
- "fraud_score": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_login_at": "2019-08-24T14:15:22Z",
- "last_name": "string",
- "max_organizations": 0,
- "max_projects": 0,
- "phone_number": "string",
- "short_id": "string",
- "timezone": "string",
- "two_factor_auth": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Add a new email address to the current user.
Email to create
address required | string |
address | string |
default | boolean |
href | string |
id | string <uuid> |
verified | boolean |
{- "address": "string"
}
{- "address": "string",
- "default": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "verified": true
}
Provides one of the user’s emails.
id required | string <uuid> Email UUID |
address | string |
default | boolean |
href | string |
id | string <uuid> |
verified | boolean |
{- "address": "string",
- "default": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "verified": true
}
Updates the email.
id required | string <uuid> Email UUID |
email to update
default | boolean |
address | string |
default | boolean |
href | string |
id | string <uuid> |
verified | boolean |
{- "default": true
}
{- "address": "string",
- "default": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "verified": true
}
Manage invitations. See project endpoints to create a new invitation. Check out the product docs to learn more about Invitations.
Returns a single invitation. (It include the invitable
to maintain backward compatibility but will be removed soon)
id required | string <uuid> Invitation UUID |
include | Array of strings 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. |
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
invitee | string <email> | ||
nonce | string | ||
object (Href) | |||
| |||
Array of objects (Href) | |||
Array
| |||
roles | Array of strings Items Enum: "admin" "billing" "collaborator" "limited_collaborator" | ||
updated_at | string <date-time> | ||
bound_roles | Array of strings |
{- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitation": {
- "href": "string"
}, - "invited_by": {
- "href": "string"
}, - "invitee": "user@example.com",
- "nonce": "string",
- "organization": {
- "href": "string"
}, - "projects": [
- {
- "href": "string"
}
], - "roles": [
- "admin"
], - "updated_at": "2019-08-24T14:15:22Z",
- "bound_roles": [
- "permrv2-:id"
]
}
Accept an invitation.
id required | string <uuid> Invitation UUID |
include | Array of strings 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. |
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
roles | Array of strings | ||
updated_at | string <date-time> | ||
object (Href) | |||
| |||
bound_roles | Array of strings |
{- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "roles": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "href": "string"
}, - "bound_roles": [
- "string"
]
}
Membership Management (Project). Check out the product docs to learn more about Membership.
Returns a single membership.
id required | string <uuid> Membership UUID |
include | Array of strings 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. |
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
roles | Array of strings | ||
updated_at | string <date-time> | ||
object (Href) | |||
| |||
bound_roles | Array of strings |
{- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "roles": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "href": "string"
}, - "bound_roles": [
- "string"
]
}
Updates the membership.
id required | string <uuid> Membership UUID |
include | Array of strings 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. |
Membership to update
role | Array of strings |
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
roles | Array of strings | ||
updated_at | string <date-time> | ||
object (Href) | |||
| |||
bound_roles | Array of strings |
{- "role": [
- "string"
]
}
{- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "roles": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "href": "string"
}, - "bound_roles": [
- "string"
]
}
Organizations Management. Check out the product docs to learn more about Organizations.
Returns a list of organizations that are accessible to the current user.
personal | string Enum: "include" "exclude" "only" Include, exclude or show only personal organizations. |
without_projects | string Enum: "include" "exclude" "only" Include, exclude or show only organizations that have no projects. |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
object (Meta) | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
Array of objects (Organization) | |||||||||||||||||||||||||||||||||||||
Array
|
{- "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}, - "organizations": [
- {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}
]
}
Returns a single organization's details, if the user is authorized to view it.
id required | string <uuid> Organization UUID |
include | Array of strings 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 of strings 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. |
object (Address) | |||||||||||||||||||||
| |||||||||||||||||||||
object (Address) | |||||||||||||||||||||
| |||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||
credit_amount | number <float> | ||||||||||||||||||||
customdata | object | ||||||||||||||||||||
description | string | ||||||||||||||||||||
enforce_2fa_at | string <date-time> Force to all members to have enabled the two factor authentication after that date, unless the value is null | ||||||||||||||||||||
href | string | ||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||
logo | string | ||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
name | string | ||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
terms | integer | ||||||||||||||||||||
string | |||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||
website | string |
{- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}
Updates the organization.
id required | string <uuid> Organization UUID |
include | Array of strings 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 of strings 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. |
Organization to update
object (Address) | |||||||||||||||||||||
| |||||||||||||||||||||
object (Address) | |||||||||||||||||||||
| |||||||||||||||||||||
customdata | object | ||||||||||||||||||||
description | string | ||||||||||||||||||||
enforce_2fa_at | string <date-time> Force to all members to have enabled the two factor authentication after that date, unless the value is null | ||||||||||||||||||||
name | string | ||||||||||||||||||||
string | |||||||||||||||||||||
website | string |
object (Address) | |||||||||||||||||||||
| |||||||||||||||||||||
object (Address) | |||||||||||||||||||||
| |||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||
credit_amount | number <float> | ||||||||||||||||||||
customdata | object | ||||||||||||||||||||
description | string | ||||||||||||||||||||
enforce_2fa_at | string <date-time> Force to all members to have enabled the two factor authentication after that date, unless the value is null | ||||||||||||||||||||
href | string | ||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||
logo | string | ||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
name | string | ||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
terms | integer | ||||||||||||||||||||
string | |||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||
website | string |
{- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "twitter": "string",
- "website": "string"
}
{- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}
Provides the custom metadata stored for this organization in json format
id required | string <uuid> Organization UUID |
{- "error": "string",
- "errors": [
- "string"
]
}
Returns all invitations in an organization.
id required | string <uuid> Organization UUID |
include | Array of strings 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. |
page | integer <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Membership) | |||||||||||||||||
Array
|
{- "invitations": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "roles": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "href": "string"
}, - "bound_roles": [
- "string"
]
}
]
}
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
id required | string <uuid> Organization UUID |
include | Array of strings 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. |
Invitation to create
invitee required | string <email> |
message | string |
organization_id | string <uuid> |
projects_ids | Array of strings <uuid> [ items <uuid > ] |
roles | Array of strings Items Enum: "admin" "billing" "collaborator" "limited_collaborator" |
bound_roles | Array of strings |
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
invitee | string <email> | ||
nonce | string | ||
object (Href) | |||
| |||
Array of objects (Href) | |||
Array
| |||
roles | Array of strings Items Enum: "admin" "billing" "collaborator" "limited_collaborator" | ||
updated_at | string <date-time> | ||
bound_roles | Array of strings |
{- "invitee": "user@example.com",
- "message": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "projects_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "roles": [
- "admin"
], - "bound_roles": [
- "permrv2-:id"
]
}
{- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitation": {
- "href": "string"
}, - "invited_by": {
- "href": "string"
}, - "invitee": "user@example.com",
- "nonce": "string",
- "organization": {
- "href": "string"
}, - "projects": [
- {
- "href": "string"
}
], - "roles": [
- "admin"
], - "updated_at": "2019-08-24T14:15:22Z",
- "bound_roles": [
- "permrv2-:id"
]
}
Returns a listing of available operating systems for the given organization
id required | string <uuid> Organization UUID |
include | Array of strings 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. |
Array of objects (OperatingSystem) | |||||||||||||||||||||||||||||||||||||
Array
|
{- "operating_systems": [
- {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}
]
}
Returns all payment methods of an organization.
id required | string <uuid> Organization UUID |
include | Array of strings 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. |
page | integer <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (PaymentMethod) | |||||||||||||||||||||||||||||||
Array
|
{- "payment_methods": [
- {
- "billing_address": {
- "country_code_alpha2": "string",
- "postal_code": "string",
- "street_address": "string"
}, - "card_type": "string",
- "cardholder_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by_user": {
- "href": "string"
}, - "default": true,
- "email": "string",
- "expiration_month": "string",
- "expiration_year": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organization": {
- "href": "string"
}, - "projects": [
- {
- "href": "string"
}
], - "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Creates a payment method.
id required | string <uuid> Organization UUID |
include | Array of strings 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. |
Payment Method to create
default | boolean |
name required | string |
nonce required | string |
object (PaymentMethodBillingAddress) | |||||||
| |||||||
card_type | string | ||||||
cardholder_name | string | ||||||
created_at | string <date-time> | ||||||
object (Href) | |||||||
| |||||||
default | boolean | ||||||
string | |||||||
expiration_month | string | ||||||
expiration_year | string | ||||||
id | string <uuid> | ||||||
name | string | ||||||
object (Href) | |||||||
| |||||||
Array of objects (Href) | |||||||
Array
| |||||||
type | string | ||||||
updated_at | string <date-time> |
{- "default": true,
- "name": "string",
- "nonce": "string"
}
{- "billing_address": {
- "country_code_alpha2": "string",
- "postal_code": "string",
- "street_address": "string"
}, - "card_type": "string",
- "cardholder_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by_user": {
- "href": "string"
}, - "default": true,
- "email": "string",
- "expiration_month": "string",
- "expiration_year": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organization": {
- "href": "string"
}, - "projects": [
- {
- "href": "string"
}
], - "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Returns a listing of available plans for the given organization
id required | string <uuid> Organization UUID |
include | Array of strings 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 of strings 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. |
Array of objects (Plan) | |||||||||||||||||||||||||||||
Array
|
{- "plans": [
- {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}
]
}
Returns a collection of projects that belong to the organization.
id required | string <uuid> Organization UUID |
name | string Filter results by name. |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
Array of objects (Project) | |||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}, - "projects": [
- {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}
]
}
Creates a new project for the organization
id required | string <uuid> Organization UUID |
include | Array of strings 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 of strings 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. |
Project to create
customdata | object |
name required | string [ 1 .. 80 ] characters The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. |
payment_method_id | string <uuid> |
type | string Value: "default" The type of the project. If no type is specified the project type will automatically be |
tags | Array of strings |
backend_transfer_enabled | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customdata | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_devices | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string [ 1 .. 80 ] characters The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_status | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Organization) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "default" The type of the project. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
{- "customdata": { },
- "name": "string",
- "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
- "type": "default",
- "tags": [
- "string"
]
}
{- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}
Provides a collection of project transfer requests from or to the organization.
id required | string <uuid> Organization UUID |
include | Array of strings 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. |
Array of objects (TransferRequest) | |||||||||||||
Array
|
{- "transfers": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "target_organization": {
- "href": "string"
}, - "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get all Members of an Organization
organization_id required | string <uuid> Organization UUID |
include | Array of strings 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. |
Array of objects (Member) | |||||||||||||||||
Array
|
{- "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "roles": [
- "admin"
], - "projects_count": 0,
- "bound_roles": [
- "permrv2-:id"
], - "user": {
- "href": "string"
}, - "organization": {
- "href": "string"
}, - "projects": [
- {
- "href": "string"
}
], - "href": "string"
}
]
}
Update organization member by assigning roles that determine which actions they can perform within the organization.
organization_id required | string <uuid> Organization UUID |
id required | string <uuid> Member UUID |
Organization to update
role | Array of strings Items Enum: "admin" "billing" "collaborator" "limited_collaborator" Primary role for the user within the organization |
bound_roles | Array of strings Additional roles that can be bound to the user to grant extra permissions. |
project_ids | Array of strings <uuid> [ items <uuid > ] Project IDs the user should be able to access. This field is only required when role is set to |
id | string <uuid> | ||
roles | Array of strings Items Enum: "admin" "billing" "collaborator" "limited_collaborator" | ||
projects_count | integer | ||
bound_roles | Array of strings | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
Array of objects (Href) | |||
Array
| |||
href | string |
{- "role": [
- "admin"
], - "bound_roles": [
- "permrv2-:id"
], - "project_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "roles": [
- "admin"
], - "projects_count": 0,
- "bound_roles": [
- "permrv2-:id"
], - "user": {
- "href": "string"
}, - "organization": {
- "href": "string"
}, - "projects": [
- {
- "href": "string"
}
], - "href": "string"
}
OTP Management. Check out the product docs to learn more about OTP.
Password Reset Token Management
Payment Method Management
Returns a payment method
id required | string <uuid> Payment Method UUID |
include | Array of strings 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. |
object (PaymentMethodBillingAddress) | |||||||
| |||||||
card_type | string | ||||||
cardholder_name | string | ||||||
created_at | string <date-time> | ||||||
object (Href) | |||||||
| |||||||
default | boolean | ||||||
string | |||||||
expiration_month | string | ||||||
expiration_year | string | ||||||
id | string <uuid> | ||||||
name | string | ||||||
object (Href) | |||||||
| |||||||
Array of objects (Href) | |||||||
Array
| |||||||
type | string | ||||||
updated_at | string <date-time> |
{- "billing_address": {
- "country_code_alpha2": "string",
- "postal_code": "string",
- "street_address": "string"
}, - "card_type": "string",
- "cardholder_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by_user": {
- "href": "string"
}, - "default": true,
- "email": "string",
- "expiration_month": "string",
- "expiration_year": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organization": {
- "href": "string"
}, - "projects": [
- {
- "href": "string"
}
], - "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Updates the payment method.
id required | string <uuid> Payment Method UUID |
include | Array of strings 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. |
Payment Method to update
billing_address | object |
cardholder_name | string |
default | boolean |
expiration_month | string |
expiration_year | integer |
name | string |
object (PaymentMethodBillingAddress) | |||||||
| |||||||
card_type | string | ||||||
cardholder_name | string | ||||||
created_at | string <date-time> | ||||||
object (Href) | |||||||
| |||||||
default | boolean | ||||||
string | |||||||
expiration_month | string | ||||||
expiration_year | string | ||||||
id | string <uuid> | ||||||
name | string | ||||||
object (Href) | |||||||
| |||||||
Array of objects (Href) | |||||||
Array
| |||||||
type | string | ||||||
updated_at | string <date-time> |
{- "billing_address": { },
- "cardholder_name": "string",
- "default": true,
- "expiration_month": "string",
- "expiration_year": 0,
- "name": "string"
}
{- "billing_address": {
- "country_code_alpha2": "string",
- "postal_code": "string",
- "street_address": "string"
}, - "card_type": "string",
- "cardholder_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by_user": {
- "href": "string"
}, - "default": true,
- "email": "string",
- "expiration_month": "string",
- "expiration_year": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organization": {
- "href": "string"
}, - "projects": [
- {
- "href": "string"
}
], - "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Project Management. Check out the product docs to learn more about Projects.
Returns a collection of projects that the current user is a member of.
name | string Filter results by name. |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
Array of objects (Project) | |||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}, - "projects": [
- {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}
]
}
Creates a new project for the user's default organization. If the user does not have a default organization, the API will look for a personal organization belonging to the user with the name "{User's Full Name} Projects" to associate the project with. If that organization does not exist a new organization named "{User's Full Name} Projects" will be created and the new project will be tied to that organization.
include | Array of strings 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 of strings 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. |
Project to create
customdata | object |
name required | string [ 1 .. 80 ] characters The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. |
organization_id | string <uuid> |
payment_method_id | string <uuid> |
type | string Value: "default" The type of the project. If no type is specified the project type will automatically be |
tags | Array of strings |
backend_transfer_enabled | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customdata | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_devices | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string [ 1 .. 80 ] characters The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_status | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Organization) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "default" The type of the project. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
{- "customdata": { },
- "name": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
- "type": "default",
- "tags": [
- "string"
]
}
{- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}
Returns a single project if the user has access
id required | string <uuid> Project UUID |
include | Array of strings 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 of strings 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. |
backend_transfer_enabled | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customdata | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_devices | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string [ 1 .. 80 ] characters The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_status | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Organization) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "default" The type of the project. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
{- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}
Updates the project.
id required | string <uuid> Project UUID |
include | Array of strings 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 of strings 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. |
Project to update
backend_transfer_enabled | boolean |
customdata | object |
name | string [ 1 .. 80 ] characters The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. |
payment_method_id | string <uuid> |
tags | Array of strings |
backend_transfer_enabled | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customdata | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_devices | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string [ 1 .. 80 ] characters The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_status | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Organization) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "default" The type of the project. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
{- "backend_transfer_enabled": true,
- "customdata": { },
- "name": "string",
- "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
- "tags": [
- "string"
]
}
{- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}
Organization owners can transfer their projects to other organizations.
id required | string <uuid> UUID of the project to be transferred |
include | Array of strings 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. |
Transfer Request to create
target_organization_id | string <uuid> |
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
updated_at | string <date-time> |
{- "target_organization_id": "86e737fc-f10c-4261-bf49-58acf935bd4d"
}
{- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "target_organization": {
- "href": "string"
}, - "updated_at": "2019-08-24T14:15:22Z"
}
Returns all invitations in a project.
project_id required | string <uuid> Project UUID |
include | Array of strings 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. |
page | integer <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Membership) | |||||||||||||||||
Array
|
{- "invitations": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "roles": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "href": "string"
}, - "bound_roles": [
- "string"
]
}
]
}
In order to add a user to a project, they must first be invited.
project_id required | string <uuid> Project UUID |
include | Array of strings 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. |
Invitation to create
invitee required | string <email> |
message | string |
organization_id | string <uuid> |
projects_ids | Array of strings <uuid> [ items <uuid > ] |
roles | Array of strings Items Enum: "admin" "billing" "collaborator" "limited_collaborator" |
bound_roles | Array of strings |
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
invitee | string <email> | ||
nonce | string | ||
object (Href) | |||
| |||
Array of objects (Href) | |||
Array
| |||
roles | Array of strings Items Enum: "admin" "billing" "collaborator" "limited_collaborator" | ||
updated_at | string <date-time> | ||
bound_roles | Array of strings |
{- "invitee": "user@example.com",
- "message": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "projects_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "roles": [
- "admin"
], - "bound_roles": [
- "permrv2-:id"
]
}
{- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitation": {
- "href": "string"
}, - "invited_by": {
- "href": "string"
}, - "invitee": "user@example.com",
- "nonce": "string",
- "organization": {
- "href": "string"
}, - "projects": [
- {
- "href": "string"
}
], - "roles": [
- "admin"
], - "updated_at": "2019-08-24T14:15:22Z",
- "bound_roles": [
- "permrv2-:id"
]
}
Provides the custom metadata stored for this IP Reservation in json format
project_id required | string <uuid> Project UUID |
id required | string <uuid> Ip Reservation UUID |
{- "error": "string",
- "errors": [
- "string"
]
}
Returns all memberships in a project.
project_id required | string <uuid> Project UUID |
search | string Search by member full name, id and email. |
include | Array of strings 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. |
page | integer <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Membership) | |||||||||||||||||
Array
|
{- "memberships": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "roles": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "href": "string"
}, - "bound_roles": [
- "string"
]
}
]
}
This list of roles can be used to update Members or new Invitations with additional permissions.
id required | string <uuid> Organization UUID |
roles | object |
{- "roles": { }
}
Learn what actions are in each role.
id required | string <uuid> Organization UUID |
role_id required | string Role ID |
id | string |
name | string |
actions | Array of strings |
{- "id": "string",
- "name": "string",
- "actions": [
- "string"
]
}
Manage SSH keys. See project endpoints to list and create project-level SSH keys.
Returns a collection of the device's ssh keys.
id required | string <uuid> Project UUID |
Search string | string Search by key, label, or fingerprint |
include | Array of strings 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. |
Array of objects (SSHKey) | |||||||||||||||||||
Array
|
{- "ssh_keys": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "entity": {
- "href": "string"
}, - "fingerprint": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "label": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
]
}
Returns a collection of the project's ssh keys.
id required | string <uuid> Project UUID |
query | string Search by key, label, or fingerprint |
include | Array of strings 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. |
Array of objects (SSHKey) | |||||||||||||||||||
Array
|
{- "ssh_keys": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "entity": {
- "href": "string"
}, - "fingerprint": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "label": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
]
}
Creates a ssh key.
id required | string <uuid> Project UUID |
include | Array of strings 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. |
ssh key to create
instances_ids | Array of strings <uuid> [ items <uuid > ] List of instance UUIDs to associate SSH key with, when empty array is sent all instances belonging to entity will be included |
key | string |
label | string |
tags | Array of strings |
created_at | string <date-time> | ||
object (Href) | |||
| |||
fingerprint | string | ||
href | string | ||
id | string <uuid> | ||
key | string | ||
label | string | ||
updated_at | string <date-time> | ||
tags | Array of strings |
{- "instances_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "key": "string",
- "label": "string",
- "tags": [
- "string"
]
}
{- "created_at": "2019-08-24T14:15:22Z",
- "entity": {
- "href": "string"
}, - "fingerprint": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "label": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
Returns a collection of the user’s ssh keys.
search | string Search by key, label, or fingerprint |
include | Array of strings 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. |
Array of objects (SSHKey) | |||||||||||||||||||
Array
|
{- "ssh_keys": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "entity": {
- "href": "string"
}, - "fingerprint": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "label": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
]
}
Creates a ssh key.
include | Array of strings 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. |
ssh key to create
instances_ids | Array of strings <uuid> [ items <uuid > ] List of instance UUIDs to associate SSH key with, when empty array is sent all instances belonging to entity will be included |
key | string |
label | string |
tags | Array of strings |
created_at | string <date-time> | ||
object (Href) | |||
| |||
fingerprint | string | ||
href | string | ||
id | string <uuid> | ||
key | string | ||
label | string | ||
updated_at | string <date-time> | ||
tags | Array of strings |
{- "instances_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "key": "string",
- "label": "string",
- "tags": [
- "string"
]
}
{- "created_at": "2019-08-24T14:15:22Z",
- "entity": {
- "href": "string"
}, - "fingerprint": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "label": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
Returns a single ssh key if the user has access
id required | string <uuid> SSH Key UUID |
include | Array of strings 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. |
created_at | string <date-time> | ||
object (Href) | |||
| |||
fingerprint | string | ||
href | string | ||
id | string <uuid> | ||
key | string | ||
label | string | ||
updated_at | string <date-time> | ||
tags | Array of strings |
{- "created_at": "2019-08-24T14:15:22Z",
- "entity": {
- "href": "string"
}, - "fingerprint": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "label": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
Updates the ssh key.
id required | string <uuid> SSH Key UUID |
include | Array of strings 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. |
ssh key to update
key | string |
label | string |
tags | Array of strings |
created_at | string <date-time> | ||
object (Href) | |||
| |||
fingerprint | string | ||
href | string | ||
id | string <uuid> | ||
key | string | ||
label | string | ||
updated_at | string <date-time> | ||
tags | Array of strings |
{- "key": "string",
- "label": "string",
- "tags": [
- "string"
]
}
{- "created_at": "2019-08-24T14:15:22Z",
- "entity": {
- "href": "string"
}, - "fingerprint": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "label": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
Support Ticket.
Support Request to create
device_id | string |
message required | string |
priority | string Enum: "urgent" "high" "medium" "low" |
project_id | string |
subject required | string |
{- "device_id": "string",
- "message": "string",
- "priority": "urgent",
- "project_id": "string",
- "subject": "string"
}
{- "error": "string",
- "errors": [
- "string"
]
}
Project Transfer Requests Management
Returns a single transfer request.
id required | string <uuid> Transfer request UUID |
include | Array of strings 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. |
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
updated_at | string <date-time> |
{- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "target_organization": {
- "href": "string"
}, - "updated_at": "2019-08-24T14:15:22Z"
}
Two Factor Authentication Management. Check out the product docs to learn more about 2FA.
User Management
Returns all invitations in current user.
include | Array of strings 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. |
page | integer <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Membership) | |||||||||||||||||
Array
|
{- "invitations": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "roles": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "href": "string"
}, - "bound_roles": [
- "string"
]
}
]
}
Returns the user object for the currently logged-in user.
include | Array of strings 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 of strings 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. |
avatar_thumb_url | string | ||
avatar_url | string | ||
created_at | string <date-time> | ||
customdata | object | ||
default_organization_id | string <uuid> | ||
default_project_id | string <uuid> | ||
string | |||
Array of objects (Href) | |||
Array
| |||
first_name | string | ||
fraud_score | string | ||
full_name | string | ||
href | string | ||
id | string <uuid> | ||
last_login_at | string <date-time> | ||
last_name | string | ||
max_organizations | integer | ||
max_projects | integer | ||
phone_number | string | ||
short_id | string | ||
timezone | string | ||
two_factor_auth | string | ||
updated_at | string <date-time> |
{- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "default_organization_id": "7498eaa8-62af-4757-81e0-959250fc9cd5",
- "default_project_id": "1226a120-3a85-4fe0-bba2-cdfc7af0d81b",
- "email": "string",
- "emails": [
- {
- "href": "string"
}
], - "first_name": "string",
- "fraud_score": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_login_at": "2019-08-24T14:15:22Z",
- "last_name": "string",
- "max_organizations": 0,
- "max_projects": 0,
- "phone_number": "string",
- "short_id": "string",
- "timezone": "string",
- "two_factor_auth": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Updates the currently logged-in user.
include | Array of strings 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 of strings 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. |
User to update
customdata | object |
first_name | string |
last_name | string |
password | string |
phone_number | string |
timezone | string |
avatar_thumb_url | string | ||
avatar_url | string | ||
created_at | string <date-time> | ||
customdata | object | ||
default_organization_id | string <uuid> | ||
default_project_id | string <uuid> | ||
string | |||
Array of objects (Href) | |||
Array
| |||
first_name | string | ||
fraud_score | string | ||
full_name | string | ||
href | string | ||
id | string <uuid> | ||
last_login_at | string <date-time> | ||
last_name | string | ||
max_organizations | integer | ||
max_projects | integer | ||
phone_number | string | ||
short_id | string | ||
timezone | string | ||
two_factor_auth | string | ||
updated_at | string <date-time> |
{- "customdata": { },
- "first_name": "string",
- "last_name": "string",
- "password": "string",
- "phone_number": "string",
- "timezone": "string"
}
{- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "default_organization_id": "7498eaa8-62af-4757-81e0-959250fc9cd5",
- "default_project_id": "1226a120-3a85-4fe0-bba2-cdfc7af0d81b",
- "email": "string",
- "emails": [
- {
- "href": "string"
}
], - "first_name": "string",
- "fraud_score": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_login_at": "2019-08-24T14:15:22Z",
- "last_name": "string",
- "max_organizations": 0,
- "max_projects": 0,
- "phone_number": "string",
- "short_id": "string",
- "timezone": "string",
- "two_factor_auth": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Returns a list of users that the are accessible to the current user (all users in the current user’s projects, essentially).
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||
Array of objects (User) | |||||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}, - "users": [
- {
- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "default_organization_id": "7498eaa8-62af-4757-81e0-959250fc9cd5",
- "default_project_id": "1226a120-3a85-4fe0-bba2-cdfc7af0d81b",
- "email": "string",
- "emails": [
- {
- "href": "string"
}
], - "first_name": "string",
- "fraud_score": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_login_at": "2019-08-24T14:15:22Z",
- "last_name": "string",
- "max_organizations": 0,
- "max_projects": 0,
- "phone_number": "string",
- "short_id": "string",
- "timezone": "string",
- "two_factor_auth": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Creates a user.
include | Array of strings 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 of strings 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. |
User to create
company_name | string | ||||
company_url | string | ||||
customdata | object | ||||
required | Array of objects (EmailInput) | ||||
Array
| |||||
first_name required | string | ||||
last_name required | string | ||||
level | string | ||||
password | string | ||||
phone_number | string | ||||
social_accounts | object | ||||
timezone | string | ||||
title | string | ||||
two_factor_auth | string | ||||
verified_at | string <date-time> | ||||
invitation_id | string <uuid> | ||||
nonce | string |
{- "company_name": "string",
- "company_url": "string",
- "customdata": { },
- "emails": [
- {
- "address": "string",
- "default": true
}
], - "first_name": "string",
- "last_name": "string",
- "level": "string",
- "password": "string",
- "phone_number": "string",
- "social_accounts": { },
- "timezone": "string",
- "title": "string",
- "two_factor_auth": "string",
- "verified_at": "2019-08-24T14:15:22Z",
- "invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
- "nonce": "string"
}
{- "error": "string",
- "errors": [
- "string"
]
}
Returns a single user if the user has access
id required | string <uuid> User UUID |
include | Array of strings 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 of strings 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. |
avatar_thumb_url | string | ||
avatar_url | string | ||
created_at | string <date-time> | ||
customdata | object | ||
default_organization_id | string <uuid> | ||
default_project_id | string <uuid> | ||
string | |||
Array of objects (Href) | |||
Array
| |||
first_name | string | ||
fraud_score | string | ||
full_name | string | ||
href | string | ||
id | string <uuid> | ||
last_login_at | string <date-time> | ||
last_name | string | ||
max_organizations | integer | ||
max_projects | integer | ||
phone_number | string | ||
short_id | string | ||
timezone | string | ||
two_factor_auth | string | ||
updated_at | string <date-time> |
{- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "default_organization_id": "7498eaa8-62af-4757-81e0-959250fc9cd5",
- "default_project_id": "1226a120-3a85-4fe0-bba2-cdfc7af0d81b",
- "email": "string",
- "emails": [
- {
- "href": "string"
}
], - "first_name": "string",
- "fraud_score": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_login_at": "2019-08-24T14:15:22Z",
- "last_name": "string",
- "max_organizations": 0,
- "max_projects": 0,
- "phone_number": "string",
- "short_id": "string",
- "timezone": "string",
- "two_factor_auth": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
User Verification Token Management
Creates an email verification request
login required | string Email for verification request |
include | Array of strings 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. |
{- "error": "string",
- "errors": [
- "string"
]
}
Consumes an email verification token and verifies the user associated with it.
include | Array of strings 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. |
Email to create
user_token required | string User verification token |
{- "user_token": "string"
}
{- "error": "string",
- "errors": [
- "string"
]
}
Returns a list of the interconnection events
connection_id required | string <uuid> Interconnection UUID |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
{- "events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Returns a list of the interconnection port events
connection_id required | string <uuid> Interconnection UUID |
id required | string <uuid> Interconnection Port UUID |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
body | string | ||
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
interpolated | string | ||
Array of objects (Href) | |||
Array
| |||
state | string | ||
type | string | ||
modified_by | object | ||
ip | string |
{- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
Returns a list of events pertaining to a specific device
id required | string <uuid> Device UUID |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
{- "events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Returns a list of the current user’s events
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
{- "events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Returns a single event if the user has access
id required | string <uuid> Event UUID |
include | Array of strings 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 of strings 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. |
body | string | ||
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
interpolated | string | ||
Array of objects (Href) | |||
Array
| |||
state | string | ||
type | string | ||
modified_by | object | ||
ip | string |
{- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
Returns a list of events for a single organization
id required | string <uuid> Organization UUID |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
{- "events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Returns a list of events for a single project
id required | string <uuid> Project UUID |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
{- "events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Returns a list of the VRF route events
id required | string <uuid> VRF Route UUID |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
body | string | ||
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
interpolated | string | ||
Array of objects (Href) | |||
Array
| |||
state | string | ||
type | string | ||
modified_by | object | ||
ip | string |
{- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
Returns a list of the virtual circuit events
id required | string <uuid> Virtual Circuit UUID |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
body | string | ||
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
interpolated | string | ||
Array of objects (Href) | |||
Array
| |||
state | string | ||
type | string | ||
modified_by | object | ||
ip | string |
{- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
Facility Management. Check out the product docs to learn more about Facilities.
Incident Management
Retrieve the number of incidents.
include | Array of strings 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 of strings 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. |
{- "error": "string",
- "errors": [
- "string"
]
}
Returns the invoice identified by the provided id
id required | string <uuid> Invoice UUID |
amount | number <float> | ||||||||||||||||||||||||||||||||||
balance | number <float> | ||||||||||||||||||||||||||||||||||
created_on | string <date> | ||||||||||||||||||||||||||||||||||
credit_amount | number <float> | ||||||||||||||||||||||||||||||||||
credits_applied | number <float> | ||||||||||||||||||||||||||||||||||
currency | string | ||||||||||||||||||||||||||||||||||
due_on | string <date> | ||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||
Array of objects (LineItem) | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
number | string | ||||||||||||||||||||||||||||||||||
object (ProjectIdName) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
reference_number | string | ||||||||||||||||||||||||||||||||||
status | string | ||||||||||||||||||||||||||||||||||
target_date | string <date> |
{- "amount": 0.1,
- "balance": 0.1,
- "created_on": "2019-08-24",
- "credit_amount": 0.1,
- "credits_applied": 0.1,
- "currency": "USD",
- "due_on": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "items": [
- {
- "amount": 0.1,
- "currency": "string",
- "description": "string",
- "details": "string",
- "plan": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "unit": "string",
- "unit_price": 0.1,
- "hostname": "string",
- "location": "string",
- "item_type": "string",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "adjustments": [
- {
- "amount": 0.1,
- "description": "string"
}
]
}
], - "number": "string",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "reference_number": "string",
- "status": "string",
- "target_date": "2019-08-24"
}
Returns all invoices for an organization
id required | string <uuid> Organization UUID |
page | integer page number |
per_page | integer per page |
status | string filter by status |
Array of objects (Invoice) | |||||||||||||||||||||||||||||
Array
|
{- "invoices": [
- {
- "amount": 0.1,
- "balance": 0.1,
- "created_on": "2019-08-24",
- "credit_amount": 0.1,
- "credits_applied": 0.1,
- "currency": "USD",
- "due_on": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "items": [
- {
- "amount": 0.1,
- "currency": "string",
- "description": "string",
- "details": "string",
- "plan": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "unit": "string",
- "unit_price": 0.1,
- "hostname": "string",
- "location": "string",
- "item_type": "string",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "adjustments": [
- {
- "amount": 0.1,
- "description": "string"
}
]
}
], - "number": "string",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "reference_number": "string",
- "status": "string",
- "target_date": "2019-08-24"
}
]
}
Manage licenses. See project endpoints to list and create licenses for a particular project.
Returns a license
id required | string <uuid> License UUID |
include | Array of strings 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 of strings 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. |
description | string | ||
id | string <uuid> | ||
license_key | string | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
size | number |
{- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "license_key": "string",
- "licensee_product": {
- "href": "string"
}, - "project": {
- "href": "string"
}, - "size": 0
}
Updates the license.
id required | string <uuid> License UUID |
include | Array of strings 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 of strings 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. |
License to update
description | string |
size | number |
description | string | ||
id | string <uuid> | ||
license_key | string | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
size | number |
{- "description": "string",
- "size": 0
}
{- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "license_key": "string",
- "licensee_product": {
- "href": "string"
}, - "project": {
- "href": "string"
}, - "size": 0
}
Provides a collection of licenses for a given project.
id required | string <uuid> Project UUID |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (License) | |||||||||||||
Array
|
{- "licenses": [
- {
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "license_key": "string",
- "licensee_product": {
- "href": "string"
}, - "project": {
- "href": "string"
}, - "size": 0
}
]
}
Creates a new license for the given project
id required | string <uuid> Project UUID |
include | Array of strings 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 of strings 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. |
License to create
description | string |
licensee_product_id | string |
size | number |
description | string | ||
id | string <uuid> | ||
license_key | string | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
size | number |
{- "description": "string",
- "licensee_product_id": "string",
- "size": 0
}
{- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "license_key": "string",
- "licensee_product": {
- "href": "string"
}, - "project": {
- "href": "string"
}, - "size": 0
}
Metro Management. Check out the product docs to learn more about Metros.
Provides a listing of available metros
Array of objects (Metro) | |||||||||
Array
|
{- "metros": [
- {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]
}
Show the details for a metro, including name, code, and country.
id required | string <uuid> Metro UUID |
code | string |
country | string |
id | string <uuid> |
name | string |
{- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Plan Management (Device). Check out the product docs to learn more about Device Plans.
Provides a listing of available plans to provision your device on.
categories[] | Array of strings Items Enum: "compute" "storage" "legacy_gen" "current_gen" Example: categories[]=compute Filter plans by its category |
type | string Enum: "standard" "workload_optimized" "custom" Example: type=standard Filter plans by its plan type |
slug | string Example: slug=c3.small.x86 Filter plans by slug |
include | Array of strings 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 of strings 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. |
Array of objects (Plan) | |||||||||||||||||||||||||||||
Array
|
{- "plans": [
- {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}
]
}
Returns a listing of available plans for the given project
id required | string <uuid> Project UUID |
include | Array of strings 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 of strings 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. |
Array of objects (Plan) | |||||||||||||||||||||||||||||
Array
|
{- "plans": [
- {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}
]
}
Returns all usages for a device.
id required | string <uuid> Device UUID |
created[after] | string <datetime> Filter usages created after this date |
created[before] | string <datetime> Filter usages created before this date |
Array of objects (DeviceUsage) | |||||||
Array
|
{- "usages": [
- {
- "quantity": "string",
- "total": "string",
- "unit": "string"
}
]
}
Returns all usages for a project.
id required | string <uuid> Project UUID |
created[after] | string <datetime> Filter usages created after this date |
created[before] | string <datetime> Filter usages created before this date |
Array of objects (ProjectUsage) | |||||||||||||||||||
Array
|
{- "usages": [
- {
- "facility": "string",
- "name": "string",
- "plan": "string",
- "plan_version": "string",
- "price": "string",
- "quantity": "string",
- "total": "string",
- "type": "string",
- "unit": "string"
}
]
}
Device Management. Check out the product docs to learn more about Server Devices.
Deletes a device and deprovisions it in our datacenter.
id required | string <uuid> Device UUID |
force_delete | boolean Force the deletion of the device, by detaching any storage volume still active. |
{- "error": "string",
- "errors": [
- "string"
]
}
Type-specific options (such as facility for baremetal devices) will be included as part of the main data structure. State value can be one of: active inactive queued or provisioning
id required | string <uuid> Device UUID |
include | Array of strings 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 of strings 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. |
always_pxe | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_cycle | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bonding_mode | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device_created_by) The user that created the device. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Default: {} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Facility) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
firmware_set_id | string <uuid> The UUID of the firmware set to associate with the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (HardwareReservation) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hostname | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
image_url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (IPAssignment) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ipxe_script_url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iqn | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locked | boolean Prevents accidental deletion of this resource when set to true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device_metro) The metro the facility is in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_frozen | boolean Whether network mode changes such as converting to/from Layer2 or Layer3 networking, bonding or disbonding network interfaces are permitted for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Port) By default, servers at Equinix Metal are configured in a “bonded” mode using LACP (Link Aggregation Control Protocol). Each 2-NIC server is configured with a single bond (namely bond0) with both interfaces eth0 and eth1 as members of the bond in a default Layer 3 mode. Some device plans may have a different number of ports and bonds available. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (OperatingSystem) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Device_actions_inner) Actions supported by the device instance. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Plan) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device_project_lite) Lite version of project object when included | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provisioning_percentage | number <float> Only visible while device provisioning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
root_password | string Root password is automatically generated when server is provisioned and it is removed after 24 hours | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
short_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spot_instance | boolean Whether or not the device is a spot instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spot_price_max | number <float> The maximum price per hour you are willing to pay to keep this spot instance. If you are outbid, the termination will be set allowing two minutes before shutdown. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "queued" "provisioning" "deprovisioning" "reinstalling" "active" "inactive" "failed" "powering_on" "powering_off" "deleted" The current state the instance is in.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Storage) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
switch_uuid | string Switch short id. This can be used to determine if two devices are connected to the same switch, for example. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
termination_time | string <date-time> When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
userdata | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sos | string Hostname used to connect to the instance via the SOS (Serial over SSH) out-of-band console. |
{- "always_pxe": true,
- "billing_cycle": "string",
- "bonding_mode": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_name": "string",
- "short_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "customdata": { },
- "description": "string",
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "firmware_set_id": "bc3d90af-8405-43ae-8e5e-2f80a3bb0f88",
- "hardware_reservation": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_rate": 1050.5,
- "device": { },
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "provisionable": true,
- "short_id": "string",
- "spare": true,
- "switch_uuid": "string",
- "termination_time": "2019-08-24T14:15:22Z"
}, - "hostname": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": "string",
- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
], - "ipxe_script_url": "string",
- "iqn": "string",
- "locked": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "network_frozen": true,
- "network_ports": [
- {
- "bond": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "data": {
- "mac": "string",
- "bonded": true
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}, - "virtual_networks": [
- {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}
]
}
], - "operating_system": {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": "string",
- "name": "string"
}
], - "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "provisioning_percentage": 0.1,
- "root_password": "string",
- "short_id": "string",
- "spot_instance": true,
- "spot_price_max": 0.1,
- "ssh_keys": [
- {
- "href": "string"
}
], - "state": "queued",
- "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "switch_uuid": "string",
- "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": "string",
- "userdata": "string",
- "volumes": [
- {
- "href": "string"
}
], - "sos": "string"
}
Updates the device.
id required | string <uuid> Device UUID |
include | Array of strings 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 of strings 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. |
Device to update
always_pxe | boolean | ||
billing_cycle | string | ||
object Default: {} | |||
| |||
description | string | ||
hostname | string | ||
firmware_set_id | string | ||
ipxe_script_url | string | ||
locked | boolean Whether the device should be locked, preventing accidental deletion. | ||
network_frozen | boolean If true, this instance can not be converted to a different network type. | ||
spot_instance | boolean Can be set to false to convert a spot-market instance to on-demand. | ||
tags | Array of strings | ||
userdata | string |
always_pxe | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_cycle | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bonding_mode | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device_created_by) The user that created the device. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Default: {} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Facility) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
firmware_set_id | string <uuid> The UUID of the firmware set to associate with the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (HardwareReservation) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hostname | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
image_url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (IPAssignment) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ipxe_script_url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iqn | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locked | boolean Prevents accidental deletion of this resource when set to true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device_metro) The metro the facility is in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_frozen | boolean Whether network mode changes such as converting to/from Layer2 or Layer3 networking, bonding or disbonding network interfaces are permitted for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Port) By default, servers at Equinix Metal are configured in a “bonded” mode using LACP (Link Aggregation Control Protocol). Each 2-NIC server is configured with a single bond (namely bond0) with both interfaces eth0 and eth1 as members of the bond in a default Layer 3 mode. Some device plans may have a different number of ports and bonds available. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (OperatingSystem) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Device_actions_inner) Actions supported by the device instance. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Plan) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device_project_lite) Lite version of project object when included | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provisioning_percentage | number <float> Only visible while device provisioning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
root_password | string Root password is automatically generated when server is provisioned and it is removed after 24 hours | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
short_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spot_instance | boolean Whether or not the device is a spot instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spot_price_max | number <float> The maximum price per hour you are willing to pay to keep this spot instance. If you are outbid, the termination will be set allowing two minutes before shutdown. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "queued" "provisioning" "deprovisioning" "reinstalling" "active" "inactive" "failed" "powering_on" "powering_off" "deleted" The current state the instance is in.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Storage) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
switch_uuid | string Switch short id. This can be used to determine if two devices are connected to the same switch, for example. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
termination_time | string <date-time> When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
userdata | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sos | string Hostname used to connect to the instance via the SOS (Serial over SSH) out-of-band console. |
{- "always_pxe": true,
- "billing_cycle": "string",
- "customdata": { },
- "description": "string",
- "hostname": "string",
- "firmware_set_id": "string",
- "ipxe_script_url": "string",
- "locked": true,
- "network_frozen": true,
- "spot_instance": true,
- "tags": [
- "string"
], - "userdata": "string"
}
{- "always_pxe": true,
- "billing_cycle": "string",
- "bonding_mode": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_name": "string",
- "short_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "customdata": { },
- "description": "string",
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "firmware_set_id": "bc3d90af-8405-43ae-8e5e-2f80a3bb0f88",
- "hardware_reservation": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_rate": 1050.5,
- "device": { },
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "provisionable": true,
- "short_id": "string",
- "spare": true,
- "switch_uuid": "string",
- "termination_time": "2019-08-24T14:15:22Z"
}, - "hostname": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": "string",
- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
], - "ipxe_script_url": "string",
- "iqn": "string",
- "locked": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "network_frozen": true,
- "network_ports": [
- {
- "bond": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "data": {
- "mac": "string",
- "bonded": true
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}, - "virtual_networks": [
- {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}
]
}
], - "operating_system": {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": "string",
- "name": "string"
}
], - "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "provisioning_percentage": 0.1,
- "root_password": "string",
- "short_id": "string",
- "spot_instance": true,
- "spot_price_max": 0.1,
- "ssh_keys": [
- {
- "href": "string"
}
], - "state": "queued",
- "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "switch_uuid": "string",
- "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": "string",
- "userdata": "string",
- "volumes": [
- {
- "href": "string"
}
], - "sos": "string"
}
Performs an action for the given device. Possible actions include: power_on, power_off, reboot, reinstall, and rescue (reboot the device into rescue OS.)
id required | string <uuid> Device UUID |
Action to perform
type required | string Enum: "power_on" "power_off" "reboot" "rescue" "reinstall" Action to perform. See Device.actions for possible actions. |
force_delete | boolean May be required to perform actions under certain conditions |
deprovision_fast | boolean When type is |
preserve_data | boolean When type is |
operating_system | string When type is |
ipxe_script_url | string When type is |
{- "type": "power_on",
- "force_delete": true,
- "deprovision_fast": true,
- "preserve_data": true,
- "operating_system": "ubuntu_22_04",
- "ipxe_script_url": "string"
}
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve an instance bandwidth for a given period of time.
id required | string <uuid> Device UUID |
from required | string Timestamp from range |
until required | string Timestamp to range |
{- "error": "string",
- "errors": [
- "string"
]
}
Provides a summary of the BGP neighbor data associated to the BGP sessions for this device.
id required | string <uuid> Device UUID |
include | Array of strings 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. |
Array of objects (BgpNeighborData) A list of BGP session neighbor data | |||||||||||||||||||||
Array
|
{- "bgp_neighbors": [
- {
- "address_family": 4,
- "customer_as": 65000,
- "customer_ip": "10.32.16.1 (IPv4) or 2604:1380:4111:2700::1 (IPv6)",
- "md5_enabled": true,
- "md5_password": "string",
- "multihop": true,
- "peer_as": 65530,
- "peer_ips": [
- "169.254.255.1",
- "169.254.255.2"
], - "routes_in": [
- {
- "exact": true,
- "route": "10.32.16.0/31"
}
], - "routes_out": [
- {
- "exact": true,
- "route": "0.0.0.0/0"
}
]
}
]
}
Provides a listing of available BGP sessions for the device.
id required | string <uuid> Device UUID |
include | Array of strings 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. |
Array of objects (BgpSession) | |||||||||||||||||||
Array
|
{- "bgp_sessions": [
- {
- "address_family": "ipv4",
- "created_at": "2019-08-24T14:15:22Z",
- "default_route": true,
- "device": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "learned_routes": [
- "10.32.16.0/31"
], - "status": "up,down",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Creates a BGP session.
id required | string <uuid> Device UUID |
include | Array of strings 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. |
BGP session to create
address_family | string Enum: "ipv4" "ipv6" Address family for BGP session. |
default_route | boolean Default: false Set the default route policy. |
address_family required | string Enum: "ipv4" "ipv6" | ||
created_at | string <date-time> | ||
default_route | boolean | ||
object (Href) | |||
| |||
href | string | ||
id | string <uuid> | ||
learned_routes | Array of strings | ||
status | string The status of the BGP Session. Multiple status values may be reported when the device is connected to multiple switches, one value per switch. Each status will start with "unknown" and progress to "up" or "down" depending on the connected device. Subsequent "unknown" values indicate a problem acquiring status from the switch. | ||
updated_at | string <date-time> |
{- "address_family": "ipv4",
- "default_route": false
}
{- "address_family": "ipv4",
- "created_at": "2019-08-24T14:15:22Z",
- "default_route": true,
- "device": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "learned_routes": [
- "10.32.16.0/31"
], - "status": "up,down",
- "updated_at": "2019-08-24T14:15:22Z"
}
Returns the health rollup status of the device.
id required | string <uuid> Device UUID |
health_rollup | string Enum: "ok" "warning" "critical" Health Status |
updated_at | string <date-time> Last update of health status. |
{- "health_rollup": "ok",
- "updated_at": "2019-08-24T14:15:22Z"
}
Returns the firmware set associated with the device. If a custom firmware set is associated with the device, then it is returned. Otherwise, if a default firmware set is available it is returned.
id required | string <uuid> Device UUID |
object (FirmwareSet) Represents a Firmware Set | |||||||||||||||||||||||||||||||||||||||||||||||
|
{- "record": {
- "uuid": "0516463a-47ee-4809-9a66-ece8c740eed9",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "attributes": [
- {
- "namespace": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "data": {
- "latest": true,
- "model": "string",
- "vendor": "string",
- "plan": "string"
}
}
], - "component_firmware": [
- {
- "uuid": "0516463a-47ee-4809-9a66-ece8c740eed9",
- "vendor": "equinix",
- "model": [
- "romed8hm3"
], - "filename": "string",
- "version": "1.5.0",
- "component": "bmc",
- "checksum": "string",
- "upstream_url": "string",
- "repository_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
}
Returns all ip assignments for a device.
id required | string <uuid> Device UUID |
include | Array of strings 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 of strings 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. |
Array of objects (IPAssignment) | |||||||||||||||||||||||||||||||||||||||
Array
|
{- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
]
}
Creates an ip assignment for a device.
id required | string <uuid> Device UUID |
include | Array of strings 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 of strings 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. |
IPAssignment to create
address required | string |
customdata | object |
address | string | ||||||||
address_family | integer | ||||||||
object (Href) | |||||||||
| |||||||||
cidr | integer | ||||||||
created_at | string <date-time> | ||||||||
enabled | boolean | ||||||||
gateway | string | ||||||||
global_ip | boolean | ||||||||
href | string | ||||||||
id | string <uuid> | ||||||||
manageable | boolean | ||||||||
management | boolean | ||||||||
object (IPAssignment_metro) The metro the IP address is in | |||||||||
| |||||||||
netmask | string | ||||||||
network | string | ||||||||
object (ParentBlock) | |||||||||
| |||||||||
public | boolean | ||||||||
state | string Enum: "pending" "active" "deleting" Only set when this is a Metal Gateway Elastic IP Assignment. Describes the current configuration state of this IP on the network. | ||||||||
next_hop | string <ipv4> Only set when this is a Metal Gateway Elastic IP Assignment. The IP address within the Metal Gateway to which requests to the Elastic IP are forwarded. |
{- "address": "string",
- "customdata": { }
}
{- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
Retrieve device metadata
id required | string <uuid> Device UUID |
class | string | ||||||||||||||||||
object Default: {} | |||||||||||||||||||
| |||||||||||||||||||
facility | string The facility code of the instance | ||||||||||||||||||
hostname | string | ||||||||||||||||||
id | string <uuid> | ||||||||||||||||||
iqn | string | ||||||||||||||||||
metro | string The metro code of the instance | ||||||||||||||||||
object (Metadata_network) | |||||||||||||||||||
| |||||||||||||||||||
operating_system | object | ||||||||||||||||||
plan | string The plan slug of the instance | ||||||||||||||||||
private_subnets | Array of strings An array of the private subnets | ||||||||||||||||||
reserved | boolean | ||||||||||||||||||
specs | object The specs of the plan version of the instance | ||||||||||||||||||
ssh_keys | Array of strings | ||||||||||||||||||
switch_short_id | string | ||||||||||||||||||
state | string Enum: "queued" "provisioning" "deprovisioning" "reinstalling" "active" "inactive" "failed" "powering_on" "powering_off" "deleted" The current state the instance is in.
| ||||||||||||||||||
tags | Array of strings | ||||||||||||||||||
volumes | Array of strings |
{- "class": "string",
- "customdata": { },
- "facility": "string",
- "hostname": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iqn": "string",
- "metro": "string",
- "network": {
- "addresses": [
- "string"
], - "interfaces": [
- { }
], - "network": {
- "bonding": {
- "link_aggregation": "string",
- "mac": "string",
- "mode": 0
}
}
}, - "operating_system": { },
- "plan": "string",
- "private_subnets": [
- "string"
], - "reserved": true,
- "specs": { },
- "ssh_keys": [
- "string"
], - "switch_short_id": "string",
- "state": "queued",
- "tags": [
- "string"
], - "volumes": [
- "string"
]
}
Returns the total amount of inbound or outbound traffic for a specific device. The default time period is 1 hour.
Please note the results capture all network traffic for the server, but not all traffic may come from or be destined to the Internet and may be non-billable. Only Internet bound traffic is charged.
id required | string <uuid> Device UUID |
direction required | string Enum: "inbound" "outbound" Traffic direction |
interval | string Enum: "minute" "hour" "day" "week" "month" "year" "hour_of_day" "day_of_week" "day_of_month" "month_of_year" Traffic interval |
bucket | string Enum: "internal" "external" Traffic bucket |
object (findTraffic_timeframe_parameter) |
{- "error": "string",
- "errors": [
- "string"
]
}
Provides the custom metadata stored for this IP Assignment in json format
instance_id required | string <uuid> Instance UUID |
id required | string <uuid> Ip Assignment UUID |
{- "error": "string",
- "errors": [
- "string"
]
}
Provides a collection of devices for a given organization.
id required | string <uuid> Organization UUID |
search | string Search by hostname, description, short_id, reservation short_id, tags, plan name, plan slug, facility code, facility name, operating system name, operating system slug, IP addresses. |
categories | Array of strings Items Enum: "compute" "storage" "legacy_gen" "current_gen" Example: categories=compute Filter by plan category |
facility | string Filter by device facility |
hostname | string Filter by partial hostname |
reserved | boolean Filter only reserved instances. When set to true, only include reserved instances. When set to false, only include on-demand instances. |
tag | string Filter by device tag |
type | string Filter by instance type (ondemand,spot,reserved) |
has_termination_time | boolean Filter only instances marked for termination. When set to true, only include instances that have a termination time. When set to false, only include instances that do not have a termination time. |
mac_address | string Filter by MAC address |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Device) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "devices": [
- {
- "always_pxe": true,
- "billing_cycle": "string",
- "bonding_mode": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_name": "string",
- "short_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "customdata": { },
- "description": "string",
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "firmware_set_id": "bc3d90af-8405-43ae-8e5e-2f80a3bb0f88",
- "hardware_reservation": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_rate": 1050.5,
- "device": { },
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "provisionable": true,
- "short_id": "string",
- "spare": true,
- "switch_uuid": "string",
- "termination_time": "2019-08-24T14:15:22Z"
}, - "hostname": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": "string",
- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
], - "ipxe_script_url": "string",
- "iqn": "string",
- "locked": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "network_frozen": true,
- "network_ports": [
- {
- "bond": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "data": {
- "mac": "string",
- "bonded": true
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": null
}
], - "memberships": [
- {
- "href": null
}
], - "name": "string",
- "projects": [
- {
- "href": null
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}, - "virtual_networks": [
- {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": null
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": null
}
], - "max_devices": { },
- "members": [
- {
- "href": null
}
], - "memberships": [
- {
- "href": null
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "billing_address": {
- "address": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- null
], - "memberships": [
- null
], - "name": "string",
- "projects": [
- null
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": null
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": null
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}
]
}
], - "operating_system": {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": "string",
- "name": "string"
}
], - "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "provisioning_percentage": 0.1,
- "root_password": "string",
- "short_id": "string",
- "spot_instance": true,
- "spot_price_max": 0.1,
- "ssh_keys": [
- {
- "href": "string"
}
], - "state": "queued",
- "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "switch_uuid": "string",
- "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": "string",
- "userdata": "string",
- "volumes": [
- {
- "href": "string"
}
], - "sos": "string"
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Provides a collection of devices for a given project.
id required | string <uuid> Project UUID |
search | string Search by hostname, description, short_id, reservation short_id, tags, plan name, plan slug, facility code, facility name, operating system name, operating system slug, IP addresses. |
categories | Array of strings Items Enum: "compute" "storage" "legacy_gen" "current_gen" Example: categories=compute Filter by plan category |
facility | string Filter by device facility |
metro | string Filter by device metro |
hostname | string Filter by partial hostname |
reserved | boolean Filter only reserved instances. When set to true, only include reserved instances. When set to false, only include on-demand instances. |
tag | string Filter by device tag |
type | string Filter by instance type (ondemand,spot,reserved) |
has_termination_time | boolean Filter only instances marked for termination. When set to true, only include instances that have a termination time. When set to false, only include instances that do not have a termination time. |
mac_address | string Filter by MAC address |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (Device) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "devices": [
- {
- "always_pxe": true,
- "billing_cycle": "string",
- "bonding_mode": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_name": "string",
- "short_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "customdata": { },
- "description": "string",
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "firmware_set_id": "bc3d90af-8405-43ae-8e5e-2f80a3bb0f88",
- "hardware_reservation": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_rate": 1050.5,
- "device": { },
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "provisionable": true,
- "short_id": "string",
- "spare": true,
- "switch_uuid": "string",
- "termination_time": "2019-08-24T14:15:22Z"
}, - "hostname": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": "string",
- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
], - "ipxe_script_url": "string",
- "iqn": "string",
- "locked": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "network_frozen": true,
- "network_ports": [
- {
- "bond": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "data": {
- "mac": "string",
- "bonded": true
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": null
}
], - "memberships": [
- {
- "href": null
}
], - "name": "string",
- "projects": [
- {
- "href": null
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}, - "virtual_networks": [
- {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": null
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": null
}
], - "max_devices": { },
- "members": [
- {
- "href": null
}
], - "memberships": [
- {
- "href": null
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "billing_address": {
- "address": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- null
], - "memberships": [
- null
], - "name": "string",
- "projects": [
- null
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": null
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": null
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}
]
}
], - "operating_system": {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": "string",
- "name": "string"
}
], - "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "provisioning_percentage": 0.1,
- "root_password": "string",
- "short_id": "string",
- "spot_instance": true,
- "spot_price_max": 0.1,
- "ssh_keys": [
- {
- "href": "string"
}
], - "state": "queued",
- "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "switch_uuid": "string",
- "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": "string",
- "userdata": "string",
- "volumes": [
- {
- "href": "string"
}
], - "sos": "string"
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Creates a new device and provisions it in the specified location.
Device type-specific options are accepted. For example, baremetal
devices accept operating_system
, hostname
, and plan
. These parameters may not be accepted for other device types. The default device type is baremetal
.
id required | string <uuid> Project UUID |
include | Array of strings 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 of strings 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. |
Device to create
required | Array of strings or string (MetroInput_metro) Metro code or ID of where the device should be provisioned in, or it can be instructed to create the device in the best available metro with Additionally it is possible to set a prioritized location selection. For example | ||||||||||||||||||||||||||||||||||||
Any of Array string | |||||||||||||||||||||||||||||||||||||
always_pxe | boolean Default: false When true, devices with a | ||||||||||||||||||||||||||||||||||||
billing_cycle | string Enum: "hourly" "daily" "monthly" "yearly" The billing cycle of the device. | ||||||||||||||||||||||||||||||||||||
object Default: {} Customdata is an arbitrary JSON value that can be accessed via the metadata service. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
description | string Any description of the device or how it will be used. This may be used to inform other API consumers with project access. | ||||||||||||||||||||||||||||||||||||
features | Array of strings The features attribute allows you to optionally specify what features your server should have. In the API shorthand syntax, all features listed are
Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a
The request will only fail if there are no available servers matching the required | ||||||||||||||||||||||||||||||||||||
hardware_reservation_id | string Default: "" The Hardware Reservation UUID to provision. Alternatively, See Reserved Hardware for more details. | ||||||||||||||||||||||||||||||||||||
hostname | string The hostname to use within the operating system. The same hostname may be used on multiple devices within a project. | ||||||||||||||||||||||||||||||||||||
Array of objects (IPAddress) Default: [{"address_family":4,"public":true},{"address_family":4,"public":false},{"address_family":6,"public":true}] The `ip_addresses attribute will allow you to specify the addresses you want created with your device. The default value configures public IPv4, public IPv6, and private IPv4. Private IPv4 address is required. When specifying Some operating systems require public IPv4 address. In those cases you will receive an error message if public IPv4 is not enabled. For example, to only configure your server with a private IPv4 address, you can send It is possible to request a subnet size larger than a For example, To access a server without public IPs, you can use our Out-of-Band console access (SOS) or proxy through another server in the project with public IPs enabled. | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
ipxe_script_url | string When set, the device will chainload an iPXE Script at boot fetched from the supplied URL. See Custom iPXE for more details. | ||||||||||||||||||||||||||||||||||||
locked | boolean Default: false Whether the device should be locked, preventing accidental deletion. | ||||||||||||||||||||||||||||||||||||
network_frozen | boolean If true, this instance can not be converted to a different network type. | ||||||||||||||||||||||||||||||||||||
no_ssh_keys | boolean Default: false Overrides default behaviour of attaching all of the organization members ssh keys and project ssh keys to device if no specific keys specified | ||||||||||||||||||||||||||||||||||||
operating_system required | string The slug of the operating system to provision. Check the Equinix Metal operating system documentation for rules that may be imposed per operating system, including restrictions on IP address options and device plans. | ||||||||||||||||||||||||||||||||||||
plan required | string The slug of the device plan to provision. | ||||||||||||||||||||||||||||||||||||
private_ipv4_subnet_size | integer <int32> Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. | ||||||||||||||||||||||||||||||||||||
project_ssh_keys | Array of strings <uuid> [ items <uuid > ] A list of UUIDs identifying the device parent project that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. If no SSH keys are specified ( | ||||||||||||||||||||||||||||||||||||
public_ipv4_subnet_size | integer <int32> Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. Your project must have addresses available for a non-default request. | ||||||||||||||||||||||||||||||||||||
spot_instance | boolean Create a spot instance. Spot instances are created with a maximum bid price. If the bid price is not met, the spot instance will be terminated as indicated by the | ||||||||||||||||||||||||||||||||||||
spot_price_max | number <float> The maximum amount to bid for a spot instance. | ||||||||||||||||||||||||||||||||||||
Array of objects (SSHKeyInput) A list of new or existing project ssh_keys that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. These keys are added in addition to any keys defined by
| |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Storage) | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||
termination_time | string <date-time> When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid. | ||||||||||||||||||||||||||||||||||||
user_ssh_keys | Array of strings <uuid> [ items <uuid > ] A list of UUIDs identifying the users that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. The users must be members of the project or organization. If no SSH keys are specified ( | ||||||||||||||||||||||||||||||||||||
userdata | string The userdata presented in the metadata service for this device. Userdata is fetched and interpreted by the operating system installed on the device. Acceptable formats are determined by the operating system, with the exception of a special iPXE enabling syntax which is handled before the operating system starts. See Server User Data and Provisioning with Custom iPXE for more details. |
always_pxe | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_cycle | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bonding_mode | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device_created_by) The user that created the device. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Default: {} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Facility) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
firmware_set_id | string <uuid> The UUID of the firmware set to associate with the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (HardwareReservation) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hostname | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
image_url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (IPAssignment) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ipxe_script_url | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iqn | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locked | boolean Prevents accidental deletion of this resource when set to true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device_metro) The metro the facility is in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_frozen | boolean Whether network mode changes such as converting to/from Layer2 or Layer3 networking, bonding or disbonding network interfaces are permitted for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Port) By default, servers at Equinix Metal are configured in a “bonded” mode using LACP (Link Aggregation Control Protocol). Each 2-NIC server is configured with a single bond (namely bond0) with both interfaces eth0 and eth1 as members of the bond in a default Layer 3 mode. Some device plans may have a different number of ports and bonds available. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (OperatingSystem) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Device_actions_inner) Actions supported by the device instance. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Plan) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device_project_lite) Lite version of project object when included | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provisioning_percentage | number <float> Only visible while device provisioning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
root_password | string Root password is automatically generated when server is provisioned and it is removed after 24 hours | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
short_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spot_instance | boolean Whether or not the device is a spot instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spot_price_max | number <float> The maximum price per hour you are willing to pay to keep this spot instance. If you are outbid, the termination will be set allowing two minutes before shutdown. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "queued" "provisioning" "deprovisioning" "reinstalling" "active" "inactive" "failed" "powering_on" "powering_off" "deleted" The current state the instance is in.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Storage) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
switch_uuid | string Switch short id. This can be used to determine if two devices are connected to the same switch, for example. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
termination_time | string <date-time> When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
userdata | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sos | string Hostname used to connect to the instance via the SOS (Serial over SSH) out-of-band console. |
{- "metro": [
- "sv",
- "any"
], - "always_pxe": false,
- "billing_cycle": "hourly",
- "customdata": { },
- "description": "string",
- "features": [
- "string"
], - "hardware_reservation_id": "next-available",
- "hostname": "string",
- "ip_addresses": [
- {
- "address_family": 4,
- "public": true
}, - {
- "address_family": 4,
- "public": false
}, - {
- "address_family": 6,
- "public": true
}
], - "ipxe_script_url": "string",
- "locked": false,
- "network_frozen": true,
- "no_ssh_keys": false,
- "operating_system": "string",
- "plan": "c3.large.x86",
- "private_ipv4_subnet_size": 0,
- "project_ssh_keys": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "public_ipv4_subnet_size": 0,
- "spot_instance": true,
- "spot_price_max": 1.23,
- "ssh_keys": [
- {
- "key": "string",
- "label": "string",
- "tags": [
- "string"
]
}
], - "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "user_ssh_keys": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "userdata": "string"
}
{- "always_pxe": true,
- "billing_cycle": "string",
- "bonding_mode": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_name": "string",
- "short_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "customdata": { },
- "description": "string",
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "firmware_set_id": "bc3d90af-8405-43ae-8e5e-2f80a3bb0f88",
- "hardware_reservation": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_rate": 1050.5,
- "device": { },
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "provisionable": true,
- "short_id": "string",
- "spare": true,
- "switch_uuid": "string",
- "termination_time": "2019-08-24T14:15:22Z"
}, - "hostname": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": "string",
- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
], - "ipxe_script_url": "string",
- "iqn": "string",
- "locked": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "network_frozen": true,
- "network_ports": [
- {
- "bond": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "data": {
- "mac": "string",
- "bonded": true
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}, - "virtual_networks": [
- {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}
]
}
], - "operating_system": {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": "string",
- "name": "string"
}
], - "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "provisioning_percentage": 0.1,
- "root_password": "string",
- "short_id": "string",
- "spot_instance": true,
- "spot_price_max": 0.1,
- "ssh_keys": [
- {
- "href": "string"
}
], - "state": "queued",
- "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "switch_uuid": "string",
- "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": "string",
- "userdata": "string",
- "volumes": [
- {
- "href": "string"
}
], - "sos": "string"
}
Manage device batches. See project endpoints to list batches for a particular project. Check out the product docs to learn more about Batch Deployment.
Deletes the Batch.
id required | string <uuid> Batch UUID |
remove_associated_instances | boolean Default: false Delete all instances created from this batch |
{- "error": "string",
- "errors": [
- "string"
]
}
Returns a Batch
id required | string <uuid> Batch UUID |
include | Array of strings 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. |
created_at | string <date-time> | ||
Array of objects (Href) | |||
Array
| |||
error_messages | Array of strings | ||
id | string <uuid> | ||
object (Href) | |||
| |||
quantity | integer | ||
state | string | ||
updated_at | string <date-time> |
{- "created_at": "2019-08-24T14:15:22Z",
- "devices": [
- {
- "href": "string"
}
], - "error_messages": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "quantity": 0,
- "state": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Returns all batches for the given project
id required | string <uuid> Project UUID |
include | Array of strings 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. |
Array of objects (Batch) | |||||||||||||||||
Array
|
{- "batches": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "devices": [
- {
- "href": "string"
}
], - "error_messages": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "quantity": 0,
- "state": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Creates new devices in batch and provisions them in our datacenter.
id required | string <uuid> Project UUID |
Batches to create
Array of objects (InstancesBatchCreateInput_batches_inner) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Array of objects (Batch) | |||||||||||||||||
Array
|
{- "batches": [
- {
- "hostnames": [
- "string"
], - "quantity": 0,
- "metro": [
- "sv",
- "any"
], - "always_pxe": false,
- "billing_cycle": "hourly",
- "customdata": { },
- "description": "string",
- "features": [
- "string"
], - "hardware_reservation_id": "next-available",
- "hostname": "string",
- "ip_addresses": [
- {
- "address_family": 4,
- "public": true
}, - {
- "address_family": 4,
- "public": false
}, - {
- "address_family": 6,
- "public": true
}
], - "ipxe_script_url": "string",
- "locked": false,
- "network_frozen": true,
- "no_ssh_keys": false,
- "operating_system": "string",
- "plan": "c3.large.x86",
- "private_ipv4_subnet_size": 0,
- "project_ssh_keys": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "public_ipv4_subnet_size": 0,
- "spot_instance": true,
- "spot_price_max": 1.23,
- "ssh_keys": [
- {
- "key": "string",
- "label": "string",
- "tags": [
- "string"
]
}
], - "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "user_ssh_keys": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "userdata": "string"
}
]
}
{- "batches": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "devices": [
- {
- "href": "string"
}
], - "error_messages": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "quantity": 0,
- "state": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Capacity Management. Check out the product docs to learn more about Capacity.
Returns a list of facilities and plans with their current capacity.
object | |||||||||||
|
{- "capacity": {
- "am6": {
- "c2.medium.x86": {
- "level": "string"
}, - "m2.xlarge.x86": {
- "level": "string"
}
}, - "da11": {
- "c2.medium.x86": {
- "level": "string"
}, - "m2.xlarge.x86": {
- "level": "string"
}
}, - "sv15": {
- "c2.medium.x86": {
- "level": "string"
}, - "m2.xlarge.x86": {
- "level": "string"
}
}
}
}
Returns a list of metros and plans with their current capacity.
object | |||||||||||
|
{- "capacity": {
- "am": {
- "c2.medium.x86": {
- "level": "string",
- "available_servers": 25
}, - "m2.xlarge.x86": {
- "level": "string",
- "available_servers": 15
}
}, - "da": {
- "c2.medium.x86": {
- "level": "string",
- "available_servers": 26
}, - "m2.xlarge.x86": {
- "level": "string",
- "available_servers": 11
}
}, - "dc": {
- "c2.medium.x86": {
- "level": "string",
- "available_servers": 14
}, - "m2.xlarge.x86": {
- "level": "string",
- "available_servers": 10
}
}
}
}
Validates if a deploy can be fulfilled in a metro.
Metro to check capacity in
Array of objects (ServerInfo) | |||||||
Array
|
Array of objects (CapacityCheckPerMetroInfo) | |||||||||
Array
|
{- "servers": [
- {
- "metro": "string",
- "plan": "string",
- "quantity": "string"
}
]
}
{- "servers": [
- {
- "available": true,
- "metro": "string",
- "plan": "string",
- "quantity": "string"
}
]
}
Returns a list of metros and plans with their current capacity.
id required | string <uuid> Organization UUID |
object | |||||||||||
|
{- "capacity": {
- "am": {
- "c2.medium.x86": {
- "level": "string"
}, - "m2.xlarge.x86": {
- "level": "string"
}
}, - "da": {
- "c2.medium.x86": {
- "level": "string"
}, - "m2.xlarge.x86": {
- "level": "string"
}
}, - "dc": {
- "c2.medium.x86": {
- "level": "string"
}, - "m2.xlarge.x86": {
- "level": "string"
}
}
}
}
Console Log Details. Notice: This is a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.
Capture a screenshot from the device, if supported, via the BMC.
id required | string <uuid> Device UUID |
{- "error": "string",
- "errors": [
- "string"
]
}
Firmware Sets Management. Notice: Firmware Sets are a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.
Returns all firmware sets associated with the organization.
id required | string <uuid> Organization UUID |
page | integer page number to return |
per_page | integer items returned per page. |
page_size | integer Max number of items returned in a page | ||||||||||||
page | integer Page returned | ||||||||||||
page_count | integer Items returned in current page | ||||||||||||
total_pages | integer Total count of pages | ||||||||||||
total_record_count | integer Total count of items | ||||||||||||
Array of objects (FirmwareSet) Represents a list of FirmwareSets | |||||||||||||
Array
|
{- "page_size": 0,
- "page": 0,
- "page_count": 0,
- "total_pages": 0,
- "total_record_count": 0,
- "records": [
- {
- "uuid": "0516463a-47ee-4809-9a66-ece8c740eed9",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "attributes": [
- {
- "namespace": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "data": {
- "latest": true,
- "model": "string",
- "vendor": "string",
- "plan": "string"
}
}
], - "component_firmware": [
- {
- "uuid": "0516463a-47ee-4809-9a66-ece8c740eed9",
- "vendor": "equinix",
- "model": [
- "romed8hm3"
], - "filename": "string",
- "version": "1.5.0",
- "component": "bmc",
- "checksum": "string",
- "upstream_url": "string",
- "repository_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Returns all firmware sets associated with the project or organization.
id required | string <uuid> Project UUID |
page | integer page number to return |
per_page | integer items returned per page. |
page_size | integer Max number of items returned in a page | ||||||||||||
page | integer Page returned | ||||||||||||
page_count | integer Items returned in current page | ||||||||||||
total_pages | integer Total count of pages | ||||||||||||
total_record_count | integer Total count of items | ||||||||||||
Array of objects (FirmwareSet) Represents a list of FirmwareSets | |||||||||||||
Array
|
{- "page_size": 0,
- "page": 0,
- "page_count": 0,
- "total_pages": 0,
- "total_record_count": 0,
- "records": [
- {
- "uuid": "0516463a-47ee-4809-9a66-ece8c740eed9",
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "attributes": [
- {
- "namespace": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "data": {
- "latest": true,
- "model": "string",
- "vendor": "string",
- "plan": "string"
}
}
], - "component_firmware": [
- {
- "uuid": "0516463a-47ee-4809-9a66-ece8c740eed9",
- "vendor": "equinix",
- "model": [
- "romed8hm3"
], - "filename": "string",
- "version": "1.5.0",
- "component": "bmc",
- "checksum": "string",
- "upstream_url": "string",
- "repository_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Hardware Reservation Management. Check out the product docs to learn more about Reserved Hardware.
Returns a single hardware reservation
id required | string <uuid> HardwareReservation UUID |
include | Array of strings 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 of strings 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. |
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
custom_rate | number <float> Amount that will be charged for every billing_cycle. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Facility) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_of_service | boolean Whether this Device requires assistance from Equinix Metal. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Plan) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provisionable | boolean Whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
short_id | string <string> Short version of the ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spare | boolean Whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Equinix Metal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
switch_uuid | string Switch short id. This can be used to determine if two devices are connected to the same switch, for example. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
termination_time | string <date-time> Expiration date for the reservation. |
{- "created_at": "2019-08-24T14:15:22Z",
- "custom_rate": 1050.5,
- "device": {
- "always_pxe": true,
- "billing_cycle": "string",
- "bonding_mode": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_name": "string",
- "short_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "customdata": { },
- "description": "string",
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "firmware_set_id": "bc3d90af-8405-43ae-8e5e-2f80a3bb0f88",
- "hardware_reservation": { },
- "hostname": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": "string",
- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
], - "ipxe_script_url": "string",
- "iqn": "string",
- "locked": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "network_frozen": true,
- "network_ports": [
- {
- "bond": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "data": {
- "mac": "string",
- "bonded": true
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}, - "virtual_networks": [
- {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": null
}
], - "memberships": [
- {
- "href": null
}
], - "name": "string",
- "projects": [
- {
- "href": null
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}
]
}
], - "operating_system": {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": "string",
- "name": "string"
}
], - "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "provisioning_percentage": 0.1,
- "root_password": "string",
- "short_id": "string",
- "spot_instance": true,
- "spot_price_max": 0.1,
- "ssh_keys": [
- {
- "href": "string"
}
], - "state": "queued",
- "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "switch_uuid": "string",
- "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": "string",
- "userdata": "string",
- "volumes": [
- {
- "href": "string"
}
], - "sos": "string"
}, - "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "provisionable": true,
- "short_id": "string",
- "spare": true,
- "switch_uuid": "string",
- "termination_time": "2019-08-24T14:15:22Z"
}
Activate a spare hardware reservation
id required | string <uuid> Hardware Reservation UUID |
include | Array of strings 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 of strings 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. |
Note to attach to the reservation
description | string |
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
custom_rate | number <float> Amount that will be charged for every billing_cycle. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Facility) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_of_service | boolean Whether this Device requires assistance from Equinix Metal. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Plan) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provisionable | boolean Whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
short_id | string <string> Short version of the ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spare | boolean Whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Equinix Metal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
switch_uuid | string Switch short id. This can be used to determine if two devices are connected to the same switch, for example. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
termination_time | string <date-time> Expiration date for the reservation. |
{- "description": "string"
}
{- "created_at": "2019-08-24T14:15:22Z",
- "custom_rate": 1050.5,
- "device": {
- "always_pxe": true,
- "billing_cycle": "string",
- "bonding_mode": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_name": "string",
- "short_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "customdata": { },
- "description": "string",
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "firmware_set_id": "bc3d90af-8405-43ae-8e5e-2f80a3bb0f88",
- "hardware_reservation": { },
- "hostname": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": "string",
- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
], - "ipxe_script_url": "string",
- "iqn": "string",
- "locked": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "network_frozen": true,
- "network_ports": [
- {
- "bond": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "data": {
- "mac": "string",
- "bonded": true
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}, - "virtual_networks": [
- {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": null
}
], - "memberships": [
- {
- "href": null
}
], - "name": "string",
- "projects": [
- {
- "href": null
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}
]
}
], - "operating_system": {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": "string",
- "name": "string"
}
], - "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "provisioning_percentage": 0.1,
- "root_password": "string",
- "short_id": "string",
- "spot_instance": true,
- "spot_price_max": 0.1,
- "ssh_keys": [
- {
- "href": "string"
}
], - "state": "queued",
- "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "switch_uuid": "string",
- "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": "string",
- "userdata": "string",
- "volumes": [
- {
- "href": "string"
}
], - "sos": "string"
}, - "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "provisionable": true,
- "short_id": "string",
- "spare": true,
- "switch_uuid": "string",
- "termination_time": "2019-08-24T14:15:22Z"
}
Move a hardware reservation to another project
id required | string <uuid> Hardware Reservation UUID |
include | Array of strings 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 of strings 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. |
Destination Project UUID
project_id | string <uuid> |
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
custom_rate | number <float> Amount that will be charged for every billing_cycle. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Device) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Facility) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_of_service | boolean Whether this Device requires assistance from Equinix Metal. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Plan) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provisionable | boolean Whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
short_id | string <string> Short version of the ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spare | boolean Whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Equinix Metal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
switch_uuid | string Switch short id. This can be used to determine if two devices are connected to the same switch, for example. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
termination_time | string <date-time> Expiration date for the reservation. |
{- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}
{- "created_at": "2019-08-24T14:15:22Z",
- "custom_rate": 1050.5,
- "device": {
- "always_pxe": true,
- "billing_cycle": "string",
- "bonding_mode": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_name": "string",
- "short_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "customdata": { },
- "description": "string",
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "firmware_set_id": "bc3d90af-8405-43ae-8e5e-2f80a3bb0f88",
- "hardware_reservation": { },
- "hostname": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": "string",
- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
], - "ipxe_script_url": "string",
- "iqn": "string",
- "locked": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "network_frozen": true,
- "network_ports": [
- {
- "bond": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "data": {
- "mac": "string",
- "bonded": true
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}, - "virtual_networks": [
- {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": null,
- "longitude": null
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": null
}
], - "memberships": [
- {
- "href": null
}
], - "name": "string",
- "projects": [
- {
- "href": null
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}
]
}
], - "operating_system": {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": "string",
- "name": "string"
}
], - "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "interpolated": "string",
- "relationships": [
- {
- "href": "string"
}
], - "state": "string",
- "type": "string",
- "modified_by": { },
- "ip": "string"
}
], - "provisioning_percentage": 0.1,
- "root_password": "string",
- "short_id": "string",
- "spot_instance": true,
- "spot_price_max": 0.1,
- "ssh_keys": [
- {
- "href": "string"
}
], - "state": "queued",
- "storage": {
- "disks": [
- {
- "device": "string",
- "wipeTable": true,
- "partitions": [
- {
- "label": "string",
- "number": 0,
- "size": "string"
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- "string"
]
}
}
]
}, - "switch_uuid": "string",
- "tags": [
- "string"
], - "termination_time": "2021-09-03T16:32:00+03:00",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": "string",
- "userdata": "string",
- "volumes": [
- {
- "href": "string"
}
], - "sos": "string"
}, - "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "provisionable": true,
- "short_id": "string",
- "spare": true,
- "switch_uuid": "string",
- "termination_time": "2019-08-24T14:15:22Z"
}
Provides a collection of hardware reservations for a given project.
id required | string <uuid> Project UUID |
query | string Search by facility code, plan name, project name, reservation short ID or device hostname |
state | string Enum: "active" "spare" "need_of_service" Filter by hardware reservation state |
provisionable | string Value: "only" Filter hardware reservation that is provisionable |
include | Array of strings 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 of strings 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 <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
Array of objects (HardwareReservation) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
{- "hardware_reservations": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_rate": 1050.5,
- "device": {
- "always_pxe": true,
- "billing_cycle": "string",
- "bonding_mode": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_name": "string",
- "short_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "customdata": { },
- "description": "string",
- "facility": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "code": "string",
- "features": [
- "baremetal",
- "backend_transfer",
- "global_ipv4"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_ranges": [
- "2604:1380::/36",
- "147.75.192.0/21"
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "name": "string"
}, - "firmware_set_id": "bc3d90af-8405-43ae-8e5e-2f80a3bb0f88",
- "hardware_reservation": { },
- "hostname": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": "string",
- "ip_addresses": [
- {
- "address": "string",
- "address_family": 0,
- "assigned_to": {
- "href": "string"
}, - "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "enabled": true,
- "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": 0,
- "href": "string",
- "netmask": "string",
- "network": "string"
}, - "public": true,
- "state": "pending",
- "next_hop": "192.168.0.1"
}
], - "ipxe_script_url": "string",
- "iqn": "string",
- "locked": true,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "network_frozen": true,
- "network_ports": [
- {
- "bond": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "data": {
- "mac": "string",
- "bonded": true
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": null
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": null
}
], - "max_devices": { },
- "members": [
- {
- "href": null
}
], - "memberships": [
- {
- "href": null
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "billing_address": {
- "address": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- null
], - "memberships": [
- null
], - "name": "string",
- "projects": [
- null
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": null
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": null
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "gateway_address": "10.1.2.1/27",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan": 1001
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}, - "virtual_networks": [
- {
- "assigned_to": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- null
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- null
], - "max_devices": { },
- "members": [
- null
], - "memberships": [
- null
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": null,
- "billing_address": null,
- "created_at": null,
- "credit_amount": null,
- "customdata": { },
- "description": null,
- "enforce_2fa_at": null,
- "href": null,
- "id": null,
- "logo": null,
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "projects": [ ],
- "terms": null,
- "twitter": null,
- "updated_at": null,
- "website": null
}, - "payment_method": {
- "href": null
}, - "ssh_keys": [
- null
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- null
], - "type": "default",
- "tags": [
- null
]
}, - "assigned_to_virtual_circuit": true,
- "description": "string",
- "facility": {
- "href": "string"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": [
- { }
], - "metal_gateways": [
- {
- "created_at": null,
- "gateway_address": null,
- "href": null,
- "id": null,
- "state": null,
- "updated_at": null,
- "vlan": null
}
], - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "metro_code": "string",
- "vxlan": 0,
- "tags": [
- "string"
]
}
]
}
], - "operating_system": {
- "build_date": "2019-08-24",
- "deprecation_date": "2019-08-24",
- "distro": "string",
- "distro_label": "string",
- "end_of_life_date": "2019-08-24",
- "end_of_service_date": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "licensed": true,
- "lifecycle_state": "string",
- "name": "string",
- "preinstallable": true,
- "pricing": { },
- "provisionable_on": [
- "string"
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": "string",
- "name": "string"
}
], - "plan": {
- "available_in": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": 1.23
}
}
], - "categories": [
- "string"
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- "on_demand"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [
- {
- "count": 0,
- "type": "string"
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": 0,
- "type": "string",
- "size": "3.84TB",
- "category": "string"
}
], - "nics": [
- {
- "count": 2,
- "type": "string"
}
], - "features": {
- "raid": true,
- "txt": true,
- "uefi": true
}
}, - "type": "standard"
}, - "project": {
- "backend_transfer_enabled": true,
- "bgp_config": {
- "href": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "devices": [
- {
- "href": "string"
}
], - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invitations": [
- {
- "href": "string"
}
], - "max_devices": { },
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "network_status": { },
- "organization": {
- "address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "billing_address": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "country": "string",
- "state": "string",
- "zip_code": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "credit_amount": 0.1,
- "customdata": { },
- "description": "string",
- "enforce_2fa_at": "2019-08-24T14:15:22Z",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "logo": "string",
- "members": [
- {
- "href": "string"
}
], - "memberships": [
- {
- "href": "string"
}
], - "name": "string",
- "projects": [
- {
- "href": "string"
}
], - "terms": 0,
- "twitter": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "website": "string"
}, - "payment_method": {
- "href": "string"
}, - "ssh_keys": [
- {
- "href": "string"
}
], - "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "volumes": [
- {
- "href": "string"
}
], - "type": "default",
- "tags": [
- "string"
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": "string",
- "created_at": "2019-08-24T14:15:22Z"