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.
Retrieve all API keys for the project.
Returns all API keys for a specific project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (AuthToken) | |||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "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"
}
}
]
}
Create an API key for a project.
Creates an API key for a project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
API Key to create
description | string |
read_only | boolean |
Responses
Response Schema: application/json
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Request samples
- Payload
{- "description": "string",
- "read_only": true
}
Response samples
- 201
- 401
- 404
- 422
{- "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"
}
}
Retrieve all user API keys
Returns all API keys for the current user.
Authorizations:
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (AuthToken) | |||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "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"
}
}
]
}
Create an API key
Creates a API key for the current user.
Authorizations:
query Parameters
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. |
Request Body schema: application/jsonrequired
API key to create
description | string |
read_only | boolean |
Responses
Response Schema: application/json
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Request samples
- Payload
{- "description": "string",
- "read_only": true
}
Response samples
- 201
- 401
- 404
- 422
{- "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"
}
}
Create an email Deprecated
Add a new email address to the current user.
Authorizations:
Request Body schema: application/jsonrequired
Email to create
address required | string |
Responses
Response Schema: application/json
address | string |
default | boolean |
href | string |
id | string <uuid> |
verified | boolean |
Request samples
- Payload
{- "address": "string"
}
Response samples
- 201
- 401
- 422
{- "address": "string",
- "default": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "verified": true
}
Retrieve an email
Provides one of the user’s emails.
Authorizations:
path Parameters
id required | string <uuid> Email UUID |
Responses
Response Schema: application/json
address | string |
default | boolean |
href | string |
id | string <uuid> |
verified | boolean |
Response samples
- 200
- 401
- 403
- 404
{- "address": "string",
- "default": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "verified": true
}
Update the email
Updates the email.
Authorizations:
path Parameters
id required | string <uuid> Email UUID |
Request Body schema: application/jsonrequired
email to update
default | boolean |
Responses
Response Schema: application/json
address | string |
default | boolean |
href | string |
id | string <uuid> |
verified | boolean |
Request samples
- Payload
{- "default": true
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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.
View an invitation
Returns a single invitation. (It include the invitable
to maintain backward compatibility but will be removed soon)
Authorizations:
path Parameters
id required | string <uuid> Invitation UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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
Accept an invitation.
Authorizations:
path Parameters
id required | string <uuid> Invitation UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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.
Retrieve a membership
Returns a single membership.
Authorizations:
path Parameters
id required | string <uuid> Membership UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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"
]
}
Update the membership
Updates the membership.
Authorizations:
path Parameters
id required | string <uuid> Membership UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Membership to update
role | Array of strings |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "role": [
- "string"
]
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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.
Retrieve all organizations
Returns a list of organizations that are accessible to the current user.
Authorizations:
query Parameters
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 |
Responses
Response Schema: application/json
object (Meta) | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
Array of objects (Organization) | |||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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"
}
]
}
Retrieve an organization's details
Returns a single organization's details, if the user is authorized to view it.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
Update the organization
Updates the organization.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "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"
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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"
}
Retrieve the custom metadata of an organization
Provides the custom metadata stored for this organization in json format
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
Responses
Response samples
- 401
- 403
- 404
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve organization invitations
Returns all invitations in an organization.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Membership) | |||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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"
]
}
]
}
Create an invitation for an organization
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
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "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"
]
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "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"
]
}
Retrieve all operating systems visible by the organization
Returns a listing of available operating systems for the given organization
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (OperatingSystem) | |||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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
}
]
}
Retrieve all payment methods of an organization
Returns all payment methods of an organization.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (PaymentMethod) | |||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "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"
}
]
}
Create a payment method for the given organization
Creates a payment method.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Payment Method to create
default | boolean |
name required | string |
nonce required | string |
Responses
Response Schema: application/json
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> |
Request samples
- Payload
{- "default": true,
- "name": "string",
- "nonce": "string"
}
Response samples
- 201
- 401
- 404
- 422
{- "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"
}
Retrieve all plans visible by the organization
Returns a listing of available plans for the given organization
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (Plan) | |||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
]
}
Retrieve all projects of an organization
Returns a collection of projects that belong to the organization.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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 |
Responses
Response Schema: application/json
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
Array of objects (Project) | |||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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"
]
}
]
}
Create a project for the organization
Creates a new project for the organization
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "customdata": { },
- "name": "string",
- "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
- "type": "default",
- "tags": [
- "string"
]
}
Response samples
- 201
- 401
- 422
{- "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"
]
}
Retrieve all project transfer requests from or to an organization
Provides a collection of project transfer requests from or to the organization.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (TransferRequest) | |||||||||||||
Array
|
Response samples
- 200
- 401
- 403
{- "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"
}
]
}
Retrieve organization members
Get all Members of an Organization
Authorizations:
path Parameters
organization_id required | string <uuid> Organization UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (Member) | |||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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 roles for an organization member
Update organization member by assigning roles that determine which actions they can perform within the organization.
Authorizations:
path Parameters
organization_id required | string <uuid> Organization UUID |
id required | string <uuid> Member UUID |
Request Body schema: application/json
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 |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "role": [
- "admin"
], - "bound_roles": [
- "permrv2-:id"
], - "project_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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
Retrieve a payment method
Returns a payment method
Authorizations:
path Parameters
id required | string <uuid> Payment Method UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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> |
Response samples
- 200
- 401
- 404
{- "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"
}
Update the payment method
Updates the payment method.
Authorizations:
path Parameters
id required | string <uuid> Payment Method UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Payment Method to update
billing_address | object |
cardholder_name | string |
default | boolean |
expiration_month | string |
expiration_year | integer |
name | string |
Responses
Response Schema: application/json
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> |
Request samples
- Payload
{- "billing_address": { },
- "cardholder_name": "string",
- "default": true,
- "expiration_month": "string",
- "expiration_year": 0,
- "name": "string"
}
Response samples
- 200
- 401
- 404
- 422
{- "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.
Retrieve all projects
Returns a collection of projects that the current user is a member of.
Authorizations:
query Parameters
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 |
Responses
Response Schema: application/json
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
Array of objects (Project) | |||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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"
]
}
]
}
Create a project
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.
Authorizations:
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "customdata": { },
- "name": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
- "type": "default",
- "tags": [
- "string"
]
}
Response samples
- 201
- 401
- 422
{- "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"
]
}
Retrieve a project
Returns a single project if the user has access
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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"
]
}
Update the project
Updates the project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "backend_transfer_enabled": true,
- "customdata": { },
- "name": "string",
- "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
- "tags": [
- "string"
]
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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"
]
}
Create a transfer request Deprecated
Organization owners can transfer their projects to other organizations.
Authorizations:
path Parameters
id required | string <uuid> UUID of the project to be transferred |
query Parameters
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. |
Request Body schema: application/jsonrequired
Transfer Request to create
target_organization_id | string <uuid> |
Responses
Response Schema: application/json
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
updated_at | string <date-time> |
Request samples
- Payload
{- "target_organization_id": "86e737fc-f10c-4261-bf49-58acf935bd4d"
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "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"
}
Retrieve project invitations
Returns all invitations in a project.
Authorizations:
path Parameters
project_id required | string <uuid> Project UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Membership) | |||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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"
]
}
]
}
Create an invitation for a project
In order to add a user to a project, they must first be invited.
Authorizations:
path Parameters
project_id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "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"
]
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "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"
]
}
Retrieve the custom metadata of an IP Reservation
Provides the custom metadata stored for this IP Reservation in json format
Authorizations:
path Parameters
project_id required | string <uuid> Project UUID |
id required | string <uuid> Ip Reservation UUID |
Responses
Response samples
- 401
- 403
- 404
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve project memberships
Returns all memberships in a project.
Authorizations:
path Parameters
project_id required | string <uuid> Project UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Membership) | |||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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"
]
}
]
}
List available roles
This list of roles can be used to update Members or new Invitations with additional permissions.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
Responses
Response Schema: application/json
roles | object |
Response samples
- 200
- 401
- 403
{- "roles": { }
}
Get details about a specific role
Learn what actions are in each role.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
role_id required | string Role ID |
Responses
Response Schema: application/json
id | string |
name | string |
actions | Array of strings |
Response samples
- 200
- 401
- 403
{- "id": "string",
- "name": "string",
- "actions": [
- "string"
]
}
Manage SSH keys. See project endpoints to list and create project-level SSH keys.
Retrieve a device's ssh keys
Returns a collection of the device's ssh keys.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (SSHKey) | |||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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"
]
}
]
}
Retrieve a project's ssh keys
Returns a collection of the project's ssh keys.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (SSHKey) | |||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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"
]
}
]
}
Create a ssh key for the given project
Creates a ssh key.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "instances_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "key": "string",
- "label": "string",
- "tags": [
- "string"
]
}
Response samples
- 201
- 401
- 422
{- "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"
]
}
Retrieve all ssh keys
Returns a collection of the user’s ssh keys.
Authorizations:
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (SSHKey) | |||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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"
]
}
]
}
Create a ssh key for the current user
Creates a ssh key.
Authorizations:
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "instances_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "key": "string",
- "label": "string",
- "tags": [
- "string"
]
}
Response samples
- 201
- 401
- 422
{- "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"
]
}
Retrieve a ssh key
Returns a single ssh key if the user has access
Authorizations:
path Parameters
id required | string <uuid> SSH Key UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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"
]
}
Update the ssh key
Updates the ssh key.
Authorizations:
path Parameters
id required | string <uuid> SSH Key UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
ssh key to update
key | string |
label | string |
tags | Array of strings |
Responses
Response Schema: application/json
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 |
Request samples
- Payload
{- "key": "string",
- "label": "string",
- "tags": [
- "string"
]
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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"
]
}
Create a support ticket
Support Ticket.
Authorizations:
Request Body schema: application/jsonrequired
Support Request to create
device_id | string |
message required | string |
priority | string Enum: "urgent" "high" "medium" "low" |
project_id | string |
subject required | string |
Responses
Request samples
- Payload
{- "device_id": "string",
- "message": "string",
- "priority": "urgent",
- "project_id": "string",
- "subject": "string"
}
Response samples
- 401
- 403
- 404
- 422
{- "error": "string",
- "errors": [
- "string"
]
}
Project Transfer Requests Management
View a transfer request
Returns a single transfer request.
Authorizations:
path Parameters
id required | string <uuid> Transfer request UUID |
query Parameters
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. |
Responses
Response Schema: application/json
created_at | string <date-time> | ||
href | string | ||
id | string <uuid> | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
updated_at | string <date-time> |
Response samples
- 200
- 401
- 403
- 404
{- "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
Retrieve current user invitations
Returns all invitations in current user.
Authorizations:
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Membership) | |||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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"
]
}
]
}
Retrieve the current user
Returns the user object for the currently logged-in user.
Authorizations:
query Parameters
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. |
Responses
Response Schema: application/json
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> |
Response samples
- 200
- 401
{- "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"
}
Update the current user
Updates the currently logged-in user.
Authorizations:
query Parameters
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. |
Request Body schema: application/jsonrequired
User to update
customdata | object |
first_name | string |
last_name | string |
password | string |
phone_number | string |
timezone | string |
Responses
Response Schema: application/json
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> |
Request samples
- Payload
{- "customdata": { },
- "first_name": "string",
- "last_name": "string",
- "password": "string",
- "phone_number": "string",
- "timezone": "string"
}
Response samples
- 200
- 401
- 422
{- "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"
}
Retrieve all users
Returns a list of users that the are accessible to the current user (all users in the current user’s projects, essentially).
Authorizations:
query Parameters
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 |
Responses
Response Schema: application/json
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||
Array of objects (User) | |||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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"
}
]
}
Create a user
Creates a user.
Authorizations:
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Request samples
- Payload
{- "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"
}
Response samples
- 401
- 422
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve a user
Returns a single user if the user has access
Authorizations:
path Parameters
id required | string <uuid> User UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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> |
Response samples
- 200
- 401
- 403
- 404
{- "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
Create an email verification request
Creates an email verification request
Authorizations:
query Parameters
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. |
Responses
Response samples
- 401
- 422
{- "error": "string",
- "errors": [
- "string"
]
}
Verify a user using an email verification token
Consumes an email verification token and verifies the user associated with it.
Authorizations:
query Parameters
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. |
Request Body schema: application/jsonrequired
Email to create
user_token required | string User verification token |
Responses
Request samples
- Payload
{- "user_token": "string"
}
Response samples
- 401
- 422
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve interconnection events
Returns a list of the interconnection events
Authorizations:
path Parameters
connection_id required | string <uuid> Interconnection UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "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
}
}
Retrieve interconnection port events
Returns a list of the interconnection port events
Authorizations:
path Parameters
connection_id required | string <uuid> Interconnection UUID |
id required | string <uuid> Interconnection Port UUID |
query Parameters
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 |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
Retrieve device's events
Returns a list of events pertaining to a specific device
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "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
}
}
Retrieve current user's events
Returns a list of the current user’s events
Authorizations:
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
{- "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
}
}
Retrieve an event
Returns a single event if the user has access
Authorizations:
path Parameters
id required | string <uuid> Event UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
Retrieve organization's events
Returns a list of events for a single organization
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "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
}
}
Retrieve project's events
Returns a list of events for a single project
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "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
}
}
Retrieve VRF route events
Returns a list of the VRF route events
Authorizations:
path Parameters
id required | string <uuid> VRF Route UUID |
query Parameters
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 |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
Retrieve virtual circuit events
Returns a list of the virtual circuit events
Authorizations:
path Parameters
id required | string <uuid> Virtual Circuit UUID |
query Parameters
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 |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 403
- 404
{- "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
Retrieve the number of incidents.
Authorizations:
query Parameters
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. |
Responses
Response samples
- 401
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve an invoice
Returns the invoice identified by the provided id
Authorizations:
path Parameters
id required | string <uuid> Invoice UUID |
Responses
Response Schema: application/json
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> |
Response samples
- 200
- 401
- 404
{- "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"
}
Retrieve all invoices for an organization
Returns all invoices for an organization
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
page | integer page number |
per_page | integer per page |
status | string filter by status |
Responses
Response Schema: application/json
Array of objects (Invoice) | |||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "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.
Retrieve a license
Returns a license
Authorizations:
path Parameters
id required | string <uuid> License UUID |
query Parameters
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. |
Responses
Response Schema: application/json
description | string | ||
id | string <uuid> | ||
license_key | string | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
size | number |
Response samples
- 200
- 401
- 403
- 404
{- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "license_key": "string",
- "licensee_product": {
- "href": "string"
}, - "project": {
- "href": "string"
}, - "size": 0
}
Update the license
Updates the license.
Authorizations:
path Parameters
id required | string <uuid> License UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
License to update
description | string |
size | number |
Responses
Response Schema: application/json
description | string | ||
id | string <uuid> | ||
license_key | string | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
size | number |
Request samples
- Payload
{- "description": "string",
- "size": 0
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "license_key": "string",
- "licensee_product": {
- "href": "string"
}, - "project": {
- "href": "string"
}, - "size": 0
}
Retrieve all licenses
Provides a collection of licenses for a given project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (License) | |||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "licenses": [
- {
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "license_key": "string",
- "licensee_product": {
- "href": "string"
}, - "project": {
- "href": "string"
}, - "size": 0
}
]
}
Create a License
Creates a new license for the given project
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
License to create
description | string |
licensee_product_id | string |
size | number |
Responses
Response Schema: application/json
description | string | ||
id | string <uuid> | ||
license_key | string | ||
object (Href) | |||
| |||
object (Href) | |||
| |||
size | number |
Request samples
- Payload
{- "description": "string",
- "licensee_product_id": "string",
- "size": 0
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "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.
Retrieve all metros
Provides a listing of available metros
Authorizations:
Responses
Response Schema: application/json
Array of objects (Metro) | |||||||||
Array
|
Response samples
- 200
- 401
{- "metros": [
- {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]
}
Retrieve a specific Metro's details
Show the details for a metro, including name, code, and country.
Authorizations:
path Parameters
id required | string <uuid> Metro UUID |
Responses
Response Schema: application/json
code | string |
country | string |
id | string <uuid> |
name | string |
Response samples
- 200
- 404
{- "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.
Retrieve all plans
Provides a listing of available plans to provision your device on.
Authorizations:
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (Plan) | |||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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"
}
]
}
Retrieve all plans visible by the project
Returns a listing of available plans for the given project
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (Plan) | |||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
]
}
Retrieve all usages for device
Returns all usages for a device.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
created[after] | string <datetime> Filter usages created after this date |
created[before] | string <datetime> Filter usages created before this date |
Responses
Response Schema: application/json
Array of objects (DeviceUsage) | |||||||
Array
|
Response samples
- 200
- 401
- 404
{- "usages": [
- {
- "quantity": "string",
- "total": "string",
- "unit": "string"
}
]
}
Retrieve all usages for project
Returns all usages for a project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
created[after] | string <datetime> Filter usages created after this date |
created[before] | string <datetime> Filter usages created before this date |
Responses
Response Schema: application/json
Array of objects (ProjectUsage) | |||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "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.
Delete the device
Deletes a device and deprovisions it in our datacenter.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
force_delete | boolean Force the deletion of the device, by detaching any storage volume still active. |
Responses
Response samples
- 401
- 403
- 404
- 422
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve a device
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
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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. |
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
Update the device
Updates the device.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
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 |
Responses
Response Schema: application/json
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. |
Request samples
- Payload
{- "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"
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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"
}
Perform an action
Performs an action for the given device. Possible actions include: power_on, power_off, reboot, reinstall, and rescue (reboot the device into rescue OS.)
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
Request Body schema: application/jsonrequired
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 |
Responses
Request samples
- Payload
{- "type": "power_on",
- "force_delete": true,
- "deprovision_fast": true,
- "preserve_data": true,
- "operating_system": "ubuntu_22_04",
- "ipxe_script_url": "string"
}
Response samples
- 401
- 404
- 422
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve an instance bandwidth
Retrieve an instance bandwidth for a given period of time.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
from required | string Timestamp from range |
until required | string Timestamp to range |
Responses
Response samples
- 403
- 404
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve BGP neighbor data for this device
Provides a summary of the BGP neighbor data associated to the BGP sessions for this device.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (BgpNeighborData) A list of BGP session neighbor data | |||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
]
}
]
}
Retrieve all BGP sessions
Provides a listing of available BGP sessions for the device.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (BgpSession) | |||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
{- "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"
}
]
}
Create a BGP session
Creates a BGP session.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
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. |
Responses
Response Schema: application/json
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> |
Request samples
- Payload
{- "address_family": "ipv4",
- "default_route": false
}
Response samples
- 201
- 401
- 403
- 422
{- "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"
}
Get Device's Health Status
Returns the health rollup status of the device.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
Responses
Response Schema: application/json
health_rollup | string Enum: "ok" "warning" "critical" Health Status |
updated_at | string <date-time> Last update of health status. |
Response samples
- 200
- 500
{- "health_rollup": "ok",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get Device's associated Firmware Set
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.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
Responses
Response Schema: application/json
object (FirmwareSet) Represents a Firmware Set | |||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 500
{- "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"
}
]
}
}
Retrieve all ip assignments
Returns all ip assignments for a device.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (IPAssignment) | |||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "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"
}
]
}
Create an ip assignment
Creates an ip assignment for a device.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
IPAssignment to create
address required | string |
customdata | object |
Responses
Response Schema: application/json
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. |
Request samples
- Payload
{- "address": "string",
- "customdata": { }
}
Response samples
- 201
- 401
- 404
- 422
{- "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 metadata
Retrieve device metadata
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
Responses
Response Schema: application/json
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 |
Response samples
- 200
- 401
- 404
- 422
{- "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"
]
}
Retrieve device traffic
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.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
query Parameters
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) |
Responses
Response samples
- 401
- 403
- 404
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve the custom metadata of an IP Assignment
Provides the custom metadata stored for this IP Assignment in json format
Authorizations:
path Parameters
instance_id required | string <uuid> Instance UUID |
id required | string <uuid> Ip Assignment UUID |
Responses
Response samples
- 401
- 403
- 404
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve all devices of an organization
Provides a collection of devices for a given organization.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Device) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "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
}
}
Retrieve all devices of a project
Provides a collection of devices for a given project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Device) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "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
}
}
Create a device
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
.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
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. |
Responses
Response Schema: application/json
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. |
Request samples
- Payload
{- "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"
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "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.
Delete the Batch
Deletes the Batch.
Authorizations:
path Parameters
id required | string <uuid> Batch UUID |
query Parameters
remove_associated_instances | boolean Default: false Delete all instances created from this batch |
Responses
Response samples
- 403
- 404
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve a Batch
Returns a Batch
Authorizations:
path Parameters
id required | string <uuid> Batch UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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> |
Response samples
- 200
- 401
- 404
{- "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"
}
Retrieve all batches by project
Returns all batches for the given project
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (Batch) | |||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
]
}
Create a devices batch
Creates new devices in batch and provisions them in our datacenter.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
Request Body schema: application/jsonrequired
Batches to create
Array of objects (InstancesBatchCreateInput_batches_inner) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Responses
Response Schema: application/json
Array of objects (Batch) | |||||||||||||||||
Array
|
Request samples
- Payload
{- "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"
}
]
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "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.
View capacity
Returns a list of facilities and plans with their current capacity.
Authorizations:
Responses
Response Schema: application/json
object | |||||||||||
|
Response samples
- 200
- 401
{- "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"
}
}
}
}
View capacity for metros
Returns a list of metros and plans with their current capacity.
Authorizations:
Responses
Response Schema: application/json
object | |||||||||||
|
Response samples
- 200
- 401
{- "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
}
}
}
}
Check capacity for a metro
Validates if a deploy can be fulfilled in a metro.
Authorizations:
Request Body schema: application/jsonrequired
Metro to check capacity in
Array of objects (ServerInfo) | |||||||
Array
|
Responses
Response Schema: application/json
Array of objects (CapacityCheckPerMetroInfo) | |||||||||
Array
|
Request samples
- Payload
{- "servers": [
- {
- "metro": "string",
- "plan": "string",
- "quantity": "string"
}
]
}
Response samples
- 200
- 401
- 422
{- "servers": [
- {
- "available": true,
- "metro": "string",
- "plan": "string",
- "quantity": "string"
}
]
}
View available hardware plans per Metro for given organization
Returns a list of metros and plans with their current capacity.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
Responses
Response Schema: application/json
object | |||||||||||
|
Response samples
- 200
- 401
- 403
{- "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.
captureScreenshot
Capture a screenshot from the device, if supported, via the BMC.
Authorizations:
path Parameters
id required | string <uuid> Device UUID |
Responses
Response Schema: application/jpeg
Response samples
- 403
- 404
- 501
{- "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.
Get Organization's Firmware Sets
Returns all firmware sets associated with the organization.
Authorizations:
path Parameters
id required | string <uuid> Organization UUID |
query Parameters
page | integer page number to return |
per_page | integer items returned per page. |
Responses
Response Schema: application/json
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
|
Response samples
- 200
- 500
{- "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"
}
]
}
]
}
Get Project's Firmware Sets
Returns all firmware sets associated with the project or organization.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
page | integer page number to return |
per_page | integer items returned per page. |
Responses
Response Schema: application/json
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
|
Response samples
- 200
- 500
{- "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.
Retrieve a hardware reservation
Returns a single hardware reservation
Authorizations:
path Parameters
id required | string <uuid> HardwareReservation UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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. |
Response samples
- 200
- 401
- 403
- 404
{- "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
Activate a spare hardware reservation
Authorizations:
path Parameters
id required | string <uuid> Hardware Reservation UUID |
query Parameters
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. |
Request Body schema: application/jsonoptional
Note to attach to the reservation
description | string |
Responses
Response Schema: application/json
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. |
Request samples
- Payload
{- "description": "string"
}
Response samples
- 201
- 401
- 403
- 404
{- "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
Move a hardware reservation to another project
Authorizations:
path Parameters
id required | string <uuid> Hardware Reservation UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Destination Project UUID
project_id | string <uuid> |
Responses
Response Schema: application/json
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. |
Request samples
- Payload
{- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}
Response samples
- 201
- 401
- 403
- 404
{- "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"
}
Retrieve all hardware reservations for a given project
Provides a collection of hardware reservations for a given project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (HardwareReservation) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "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",
- "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"
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Operating System Images and Lifecycle Management
Retrieve all operating system versions
Provides a listing of available operating system versions.
Authorizations:
Responses
Response Schema: application/json
Array of objects (OperatingSystem) | |||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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
}
]
}
Retrieve all operating systems
Returns a list of available operating systems to provision your new device with.
Authorizations:
Responses
Response Schema: application/json
Array of objects (OperatingSystem) | |||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "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
}
]
}
Port Management. Check out the product docs to learn more about Port configurations.
Retrieve a port
Returns a port
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
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. |
Responses
Response Schema: application/json
object (BondPortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disbond_operation_supported | boolean Indicates whether or not the bond can be broken on the port (when applicable). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "NetworkPort" "NetworkBondPort" Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_type | string Enum: "layer2-bonded" "layer2-individual" "layer3" "hybrid" "hybrid-bonded" Composite network type of the bond | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "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": [
- {
- "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": [
- { }
], - "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"
}
], - "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
Assign a port to virtual network
Assign a hardware port to a virtual network.
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001').
vnid | string Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself. |
Responses
Response Schema: application/json
object (BondPortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disbond_operation_supported | boolean Indicates whether or not the bond can be broken on the port (when applicable). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "NetworkPort" "NetworkBondPort" Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_type | string Enum: "layer2-bonded" "layer2-individual" "layer3" "hybrid" "hybrid-bonded" Composite network type of the bond | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Request samples
- Payload
{- "vnid": "1001"
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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": [
- {
- "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": [
- { }
], - "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"
}
], - "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
Enabling bonding
Enabling bonding for one or all ports
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
bulk_enable | boolean enable both ports |
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. |
Responses
Response Schema: application/json
object (BondPortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disbond_operation_supported | boolean Indicates whether or not the bond can be broken on the port (when applicable). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "NetworkPort" "NetworkBondPort" Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_type | string Enum: "layer2-bonded" "layer2-individual" "layer3" "hybrid" "hybrid-bonded" Composite network type of the bond | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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": [
- {
- "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": [
- { }
], - "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"
}
], - "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
Convert to Layer 2
Converts a bond port to Layer 2. IP assignments of the port will be removed.
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001').
vnid | string Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself. |
Responses
Response Schema: application/json
object (BondPortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disbond_operation_supported | boolean Indicates whether or not the bond can be broken on the port (when applicable). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "NetworkPort" "NetworkBondPort" Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_type | string Enum: "layer2-bonded" "layer2-individual" "layer3" "hybrid" "hybrid-bonded" Composite network type of the bond | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Request samples
- Payload
{- "vnid": "1001"
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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": [
- {
- "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": [
- { }
], - "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"
}
], - "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
Convert to Layer 3
Converts a bond port to Layer 3. VLANs must first be unassigned.
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
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. |
Request Body schema: application/json
IPs to request
Array of objects (PortConvertLayer3Input_request_ips_inner) | |||||
Array
|
Responses
Response Schema: application/json
object (BondPortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disbond_operation_supported | boolean Indicates whether or not the bond can be broken on the port (when applicable). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "NetworkPort" "NetworkBondPort" Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_type | string Enum: "layer2-bonded" "layer2-individual" "layer3" "hybrid" "hybrid-bonded" Composite network type of the bond | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Request samples
- Payload
{- "request_ips": [
- {
- "address_family": 0,
- "public": true
}
]
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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": [
- {
- "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": [
- { }
], - "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"
}
], - "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
Disabling bonding
Disabling bonding for one or all ports
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
bulk_disable | boolean disable both ports |
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. |
Responses
Response Schema: application/json
object (BondPortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disbond_operation_supported | boolean Indicates whether or not the bond can be broken on the port (when applicable). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "NetworkPort" "NetworkBondPort" Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_type | string Enum: "layer2-bonded" "layer2-individual" "layer3" "hybrid" "hybrid-bonded" Composite network type of the bond | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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": [
- {
- "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": [
- { }
], - "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"
}
], - "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
Remove native VLAN
Removes the native VLAN from this port
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
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. |
Responses
Response Schema: application/json
object (BondPortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disbond_operation_supported | boolean Indicates whether or not the bond can be broken on the port (when applicable). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "NetworkPort" "NetworkBondPort" Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_type | string Enum: "layer2-bonded" "layer2-individual" "layer3" "hybrid" "hybrid-bonded" Composite network type of the bond | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
- 422
{- "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": [
- {
- "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": [
- { }
], - "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"
}
], - "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
Assign a native VLAN
Sets a virtual network on this port as a "native VLAN". The VLAN must have already been assigned using the using the "Assign a port to a virtual network" operation.
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
vnid required | string Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001'). |
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. |
Responses
Response Schema: application/json
object (BondPortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disbond_operation_supported | boolean Indicates whether or not the bond can be broken on the port (when applicable). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "NetworkPort" "NetworkBondPort" Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_type | string Enum: "layer2-bonded" "layer2-individual" "layer3" "hybrid" "hybrid-bonded" Composite network type of the bond | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
- 422
{- "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": [
- {
- "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": [
- { }
], - "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"
}
], - "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
Unassign a port
Unassign a port for a hardware.
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001').
vnid | string Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself. |
Responses
Response Schema: application/json
object (BondPortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PortData) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disbond_operation_supported | boolean Indicates whether or not the bond can be broken on the port (when applicable). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "NetworkPort" "NetworkBondPort" Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_type | string Enum: "layer2-bonded" "layer2-individual" "layer3" "hybrid" "hybrid-bonded" Composite network type of the bond | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Request samples
- Payload
{- "vnid": "1001"
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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": [
- {
- "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": [
- { }
], - "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"
}
], - "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
List Current VLAN assignments for a port
Show the port's current VLAN assignments, including if this VLAN is set as native, and the current state of the assignment (ex. 'assigned' or 'unassigning')
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
include | Array of strings Default: "port&include=virtual_network" 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. |
Responses
Response Schema: application/json
Array of objects (PortVlanAssignment) | |||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "vlan_assignments": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "native": true,
- "port": {
- "href": "string"
}, - "state": "assigned",
- "updated_at": "2019-08-24T14:15:22Z",
- "virtual_network": {
- "href": "string"
}, - "vlan": 0
}
]
}
Show a particular Port VLAN assignment's details
Show the details of a specific Port-VLAN assignment, including the current state and if the VLAN is set as native.
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
assignment_id required | string <uuid> Assignment ID |
query Parameters
include | Array of strings Default: "port&include=virtual_network" 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. |
Responses
Response Schema: application/json
created_at | string <date-time> | ||
id | string <uuid> | ||
native | boolean | ||
object (Href) | |||
| |||
state | string Enum: "assigned" "unassigning" | ||
updated_at | string <date-time> | ||
object (Href) | |||
| |||
vlan | integer |
Response samples
- 200
- 401
- 403
- 404
{- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "native": true,
- "port": {
- "href": "string"
}, - "state": "assigned",
- "updated_at": "2019-08-24T14:15:22Z",
- "virtual_network": {
- "href": "string"
}, - "vlan": 0
}
List the VLAN Assignment Batches for a port
Show all the VLAN assignment batches that have been created for managing this port's VLAN assignments
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
Responses
Response Schema: application/json
Array of objects (PortVlanAssignmentBatch) | |||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "batches": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "error_messages": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "port": {
- "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": [
- {
- "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": null,
- "longitude": null
}, - "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": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "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": null,
- "country": null,
- "id": null,
- "name": null
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- null
], - "available_in_metros": [
- null
], - "categories": [
- null
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- null
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [ ],
- "memory": null,
- "drives": [ ],
- "nics": [ ],
- "features": null
}, - "type": "standard"
}, - "project": {
- "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
]
}, - "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": null
}, - "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": null,
- "country": null,
- "id": null,
- "name": null
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": null,
- "href": null,
- "netmask": null,
- "network": null
}, - "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": [
- { }
], - "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": null,
- "price": null
}
], - "available_in_metros": [
- {
- "href": null,
- "price": null
}
], - "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": [
- null
], - "memory": {
- "total": null
}, - "drives": [
- null
], - "nics": [
- null
], - "features": {
- "raid": null,
- "txt": null,
- "uefi": null
}
}, - "type": "standard"
}, - "project": {
- "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"
]
}, - "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": [
- null
], - "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": null,
- "wipeTable": null,
- "partitions": [ ]
}
], - "raid": [
- {
- "devices": [ ],
- "level": null,
- "name": null
}
], - "filesystems": [
- {
- "mount": null
}
]
}, - "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"
}
], - "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": [
- {
- "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": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "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": null,
- "country": null,
- "id": null,
- "name": null
}, - "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": null,
- "code": null,
- "features": [ ],
- "id": null,
- "ip_ranges": [ ],
- "metro": null,
- "name": null
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [ ],
- "available_in_metros": [ ],
- "categories": [ ],
- "class": null,
- "description": null,
- "deployment_types": [ ],
- "id": null,
- "legacy": null,
- "line": null,
- "name": null,
- "pricing": { },
- "slug": null,
- "specs": null,
- "type": null
}, - "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "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": null,
- "address_family": null,
- "assigned_to": null,
- "cidr": null,
- "created_at": null,
- "enabled": null,
- "gateway": null,
- "global_ip": null,
- "href": null,
- "id": null,
- "manageable": null,
- "management": null,
- "metro": null,
- "netmask": null,
- "network": null,
- "parent_block": null,
- "public": null,
- "state": null,
- "next_hop": null
}
], - "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": [
- { }
], - "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": [
- null
], - "release_date": "2019-08-24",
- "release_notes": "string",
- "slug": "string",
- "version": "string",
- "default_operating_system": true
}, - "actions": [
- {
- "type": null,
- "name": null
}
], - "plan": {
- "available_in": [
- null
], - "available_in_metros": [
- null
], - "categories": [
- null
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- null
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [ ],
- "memory": null,
- "drives": [ ],
- "nics": [ ],
- "features": null
}, - "type": "standard"
}, - "project": {
- "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
]
}, - "project_lite": {
- "href": "string"
}, - "provisioning_events": [
- {
- "body": null,
- "created_at": null,
- "href": null,
- "id": null,
- "interpolated": null,
- "relationships": [ ],
- "state": null,
- "type": null,
- "modified_by": { },
- "ip": null
}
], - "provisioning_percentage": 0.1,
- "root_password": "string",
- "short_id": "string",
- "spot_instance": true,
- "spot_price_max": 0.1,
- "ssh_keys": [
- {
- "href": null
}
], - "state": "queued",
- "storage": {
- "disks": [
- null
], - "raid": [
- null
], - "filesystems": [
- null
]
}, - "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": null
}
], - "sos": "string"
}
], - "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"
]
}
]
}, - "quantity": 0,
- "state": "queued",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan_assignments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "native": true,
- "state": "assigned",
- "vlan": 0
}
], - "project": {
- "href": "string"
}
}
]
}
Create a new Port-VLAN Assignment management batch
Create a new asynchronous batch request which handles adding and/or removing the VLANs to which the port is assigned.
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
VLAN Assignment batch details
Array of objects (PortVlanAssignmentBatchCreateInput_vlan_assignments_inner) | |||||||
Array
|
Responses
Response Schema: application/json
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
error_messages | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Port) Port is a hardware port associated with a reserved or instantiated hardware device. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
quantity | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "queued" "in_progress" "completed" "failed" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (PortVlanAssignmentBatch_vlan_assignments_inner) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Request samples
- Payload
{- "vlan_assignments": [
- {
- "native": true,
- "state": "assigned",
- "vlan": "string"
}
]
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "created_at": "2019-08-24T14:15:22Z",
- "error_messages": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "port": {
- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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": [
- {
- "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": null,
- "longitude": null
}, - "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": null,
- "price": null
}
], - "available_in_metros": [
- {
- "href": null,
- "price": null
}
], - "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": [
- null
], - "memory": {
- "total": null
}, - "drives": [
- null
], - "nics": [
- null
], - "features": {
- "raid": null,
- "txt": null,
- "uefi": null
}
}, - "type": "standard"
}, - "project": {
- "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"
]
}, - "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": [
- { }
], - "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": null
}
], - "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": [
- null
]
}
], - "raid": [
- {
- "devices": [
- null
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": null,
- "format": null,
- "point": null,
- "options": [ ]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}, - "quantity": 0,
- "state": "queued",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan_assignments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "native": true,
- "state": "assigned",
- "vlan": 0
}
], - "project": {
- "href": "string"
}
}
Retrieve a VLAN Assignment Batch's details
Returns the details of an existing Port-VLAN Assignment batch, including the list of VLANs to assign or unassign, and the current state of the batch.
Authorizations:
path Parameters
id required | string <uuid> Port UUID |
batch_id required | string <uuid> Batch ID |
query Parameters
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. |
Responses
Response Schema: application/json
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
error_messages | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Port) Port is a hardware port associated with a reserved or instantiated hardware device. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
quantity | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "queued" "in_progress" "completed" "failed" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (PortVlanAssignmentBatch_vlan_assignments_inner) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "created_at": "2019-08-24T14:15:22Z",
- "error_messages": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "port": {
- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": [
- { }
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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": [
- {
- "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": null,
- "longitude": null
}, - "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": null,
- "price": null
}
], - "available_in_metros": [
- {
- "href": null,
- "price": null
}
], - "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": [
- null
], - "memory": {
- "total": null
}, - "drives": [
- null
], - "nics": [
- null
], - "features": {
- "raid": null,
- "txt": null,
- "uefi": null
}
}, - "type": "standard"
}, - "project": {
- "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"
]
}, - "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": [
- { }
], - "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": null
}
], - "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": [
- null
]
}
], - "raid": [
- {
- "devices": [
- null
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": null,
- "format": null,
- "point": null,
- "options": [ ]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}, - "quantity": 0,
- "state": "queued",
- "updated_at": "2019-08-24T14:15:22Z",
- "vlan_assignments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "native": true,
- "state": "assigned",
- "vlan": 0
}
], - "project": {
- "href": "string"
}
}
Self Service Reservations
Retrieve all reservations
Returns all reservations.
Authorizations:
path Parameters
project_id required | string <uuid> Project UUID |
query Parameters
page | integer <int32> [ 1 .. 100000 ] Default: 1 Page to return |
per_page | integer <int32> [ 1 .. 1000 ] Default: 10 Items returned per page |
categories | Array of strings Items Enum: "compute" "storage" "legacy_gen" "current_gen" Example: categories=compute Filter reservations by items category |
Responses
Response Schema: application/json
Array of objects (SelfServiceReservationResponse) | |||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
{- "reservations": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "item": [
- {
- "amount": 0.1,
- "id": "string",
- "metro_code": "string",
- "metro_id": "bf9f87e0-87e9-4310-9928-3f25142f3b2b",
- "metro_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"
}, - "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "plan_name": "string",
- "plan_slug": "string",
- "plan_categories": [
- "string"
], - "quantity": 0,
- "term": "string"
}
], - "notes": "string",
- "organization": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "period": {
- "count": 12,
- "unit": "monthly"
}, - "project": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "start_date": "2019-08-24T14:15:22Z",
- "status": "string",
- "total_cost": 0
}
]
}
Create a reservation
Creates a reservation.
Authorizations:
path Parameters
project_id required | string <uuid> Project UUID |
Request Body schema: application/jsonrequired
reservation to create
Array of objects (SelfServiceReservationItemRequest) | |||||||||
Array
| |||||||||
notes | string | ||||||||
object (CreateSelfServiceReservationRequest_period) | |||||||||
| |||||||||
start_date | string <date-time> |
Responses
Response Schema: application/json
created_at | string <date-time> | ||||||||||||||||||||||||
Array of objects (SelfServiceReservationItemResponse) | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
notes | string | ||||||||||||||||||||||||
organization | string | ||||||||||||||||||||||||
organization_id | string <uuid> | ||||||||||||||||||||||||
object (CreateSelfServiceReservationRequest_period) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
project | string | ||||||||||||||||||||||||
project_id | string <uuid> | ||||||||||||||||||||||||
start_date | string <date-time> | ||||||||||||||||||||||||
status | string | ||||||||||||||||||||||||
total_cost | integer |
Request samples
- Payload
{- "item": [
- {
- "metro_id": "bf9f87e0-87e9-4310-9928-3f25142f3b2b",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "quantity": 0,
- "term": "string"
}
], - "notes": "string",
- "period": {
- "count": 12,
- "unit": "monthly"
}, - "start_date": "2019-08-24T14:15:22Z"
}
Response samples
- 201
- 401
- 422
{- "created_at": "2019-08-24T14:15:22Z",
- "item": [
- {
- "amount": 0.1,
- "id": "string",
- "metro_code": "string",
- "metro_id": "bf9f87e0-87e9-4310-9928-3f25142f3b2b",
- "metro_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"
}, - "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "plan_name": "string",
- "plan_slug": "string",
- "plan_categories": [
- "string"
], - "quantity": 0,
- "term": "string"
}
], - "notes": "string",
- "organization": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "period": {
- "count": 12,
- "unit": "monthly"
}, - "project": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "start_date": "2019-08-24T14:15:22Z",
- "status": "string",
- "total_cost": 0
}
Retrieve a reservation
Returns a reservation
Authorizations:
path Parameters
id required | string <uuid> Reservation short_id |
project_id required | string <uuid> Project UUID |
Responses
Response Schema: application/json
created_at | string <date-time> | ||||||||||||||||||||||||
Array of objects (SelfServiceReservationItemResponse) | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
notes | string | ||||||||||||||||||||||||
organization | string | ||||||||||||||||||||||||
organization_id | string <uuid> | ||||||||||||||||||||||||
object (CreateSelfServiceReservationRequest_period) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
project | string | ||||||||||||||||||||||||
project_id | string <uuid> | ||||||||||||||||||||||||
start_date | string <date-time> | ||||||||||||||||||||||||
status | string | ||||||||||||||||||||||||
total_cost | integer |
Response samples
- 200
- 401
- 404
{- "created_at": "2019-08-24T14:15:22Z",
- "item": [
- {
- "amount": 0.1,
- "id": "string",
- "metro_code": "string",
- "metro_id": "bf9f87e0-87e9-4310-9928-3f25142f3b2b",
- "metro_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"
}, - "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "plan_name": "string",
- "plan_slug": "string",
- "plan_categories": [
- "string"
], - "quantity": 0,
- "term": "string"
}
], - "notes": "string",
- "organization": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "period": {
- "count": 12,
- "unit": "monthly"
}, - "project": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "start_date": "2019-08-24T14:15:22Z",
- "status": "string",
- "total_cost": 0
}
Spot Market Pricing and Requests Management. Check out the product docs to learn more about Spot Market features.
Get current spot market prices
Get Equinix Metal current spot market prices.
Authorizations:
query Parameters
facility | string Facility to check spot market prices |
plan | string Plan to check spot market prices |
Responses
Response Schema: application/json
object (SpotPricesReport) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 422
{- "spot_market_prices": {
- "ams1": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "atl1": {
- "baremetal_1e": {
- "price": 0.1
}
}, - "dfw1": {
- "baremetal_1e": {
- "price": 0.1
}
}, - "ewr1": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "fra1": {
- "baremetal_1e": {
- "price": 0.1
}
}, - "iad1": {
- "baremetal_1e": {
- "price": 0.1
}
}, - "lax1": {
- "baremetal_1e": {
- "price": 0.1
}
}, - "nrt1": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "ord1": {
- "baremetal_1e": {
- "price": 0.1
}
}, - "sea1": {
- "baremetal_1e": {
- "price": 0.1
}
}, - "sin1": {
- "baremetal_1e": {
- "price": 0.1
}
}, - "sjc1": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "syd1": {
- "baremetal_1e": {
- "price": 0.1
}
}, - "yyz1": {
- "baremetal_1e": {
- "price": 0.1
}
}
}
}
Get spot market prices for a given period of time
Get spot market prices for a given plan and facility in a fixed period of time
Note: In the 200
response, the property datapoints
contains arrays of [float, integer]
.
Authorizations:
query Parameters
facility required | string Facility to check spot market prices |
plan required | string Plan to check spot market prices |
metro | string Metro to check spot market price history |
from required | string Timestamp from range |
until required | string Timestamp to range |
Responses
Response Schema: application/json
object (SpotPricesDatapoints) | |||
|
Response samples
- 200
- 401
- 422
{- "prices_history": {
- "datapoints": [
- [
- 0
]
]
}
}
Get current spot market prices for metros
Get Equinix Metal current spot market prices for all metros.
Authorizations:
query Parameters
metro | string Metro to filter spot market prices |
plan | string Plan to filter spot market prices |
Responses
Response Schema: application/json
object (SpotMarketPricesPerMetroReport) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 422
{- "spot_market_prices": {
- "am": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "ch": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "da": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "la": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "ny": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "sg": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}, - "sv": {
- "baremetal_0": {
- "price": 0.1
}, - "baremetal_1": {
- "price": 0.1
}, - "baremetal_2": {
- "price": 0.1
}, - "baremetal_2a": {
- "price": 0.1
}, - "baremetal_2a2": {
- "price": 0.1
}, - "baremetal_3": {
- "price": 0.1
}, - "baremetal_s": {
- "price": 0.1
}, - "c2.medium.x86": {
- "price": 0.1
}, - "m2.xlarge.x86": {
- "price": 0.1
}
}
}
}
List spot market requests
View all spot market requests for a given project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
Responses
Response Schema: application/json
Array of objects (SpotMarketRequest) | |||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "spot_market_requests": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "devices_max": 0,
- "devices_min": 0,
- "end_at": "2019-08-24T14:15:22Z",
- "facilities": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": {
- "href": "string"
}, - "max_bid_price": 0.1,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "project": {
- "href": "string"
}
}
]
}
Create a spot market request
Creates a new spot market request.
Type-specific options (such as operating_system for baremetal devices) should be included in the main data structure alongside hostname and plan.
The features attribute allows you to optionally specify what features your server should have. For example, if you require a server with a TPM chip, you may specify { "features": { "tpm": "required" } }
(or { "features": ["tpm"] }
in shorthand).
The request will fail if there are no available servers matching your criteria. 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 preferred value (see the example request below).
The request will not fail if we have no servers with that feature in our inventory.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
Request Body schema: application/jsonrequired
Spot Market Request to create
devices_max | integer | ||||||||||||||||||||||||||||||||||||
devices_min | integer | ||||||||||||||||||||||||||||||||||||
end_at | string <date-time> | ||||||||||||||||||||||||||||||||||||
object (SpotMarketRequestCreateInput_instance_parameters) | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
max_bid_price | number <float> | ||||||||||||||||||||||||||||||||||||
metro | string The metro ID or code the spot market request will be created in. |
Responses
Response Schema: application/json
created_at | string <date-time> | ||||||||
devices_max | integer | ||||||||
devices_min | integer | ||||||||
end_at | string <date-time> | ||||||||
object (Href) | |||||||||
| |||||||||
href | string | ||||||||
id | string <uuid> | ||||||||
object (Href) | |||||||||
| |||||||||
max_bid_price | number <float> | ||||||||
object (SpotMarketRequest_metro) The metro the spot market request was created in | |||||||||
| |||||||||
object (Href) | |||||||||
|
Request samples
- Payload
{- "devices_max": 0,
- "devices_min": 0,
- "end_at": "2019-08-24T14:15:22Z",
- "instance_parameters": {
- "always_pxe": true,
- "billing_cycle": "string",
- "customdata": { },
- "description": "string",
- "features": [
- "string"
], - "hostname": "string",
- "hostnames": [
- "string"
], - "locked": true,
- "no_ssh_keys": true,
- "operating_system": "string",
- "plan": "string",
- "private_ipv4_subnet_size": 0,
- "project_ssh_keys": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "public_ipv4_subnet_size": 0,
- "tags": [
- "string"
], - "termination_time": "2019-08-24T14:15:22Z",
- "user_ssh_keys": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "userdata": "string"
}, - "max_bid_price": 0.1,
- "metro": "string"
}
Response samples
- 201
- 401
- 404
- 422
{- "created_at": "2019-08-24T14:15:22Z",
- "devices_max": 0,
- "devices_min": 0,
- "end_at": "2019-08-24T14:15:22Z",
- "facilities": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": {
- "href": "string"
}, - "max_bid_price": 0.1,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "project": {
- "href": "string"
}
}
Delete the spot market request
Deletes the spot market request.
Authorizations:
path Parameters
id required | string <uuid> SpotMarketRequest UUID |
query Parameters
force_termination | boolean Terminate associated spot instances |
Responses
Response samples
- 401
- 403
- 404
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve a spot market request
Returns a single spot market request
Authorizations:
path Parameters
id required | string <uuid> SpotMarketRequest UUID |
query Parameters
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. |
Responses
Response Schema: application/json
created_at | string <date-time> | ||||||||
devices_max | integer | ||||||||
devices_min | integer | ||||||||
end_at | string <date-time> | ||||||||
object (Href) | |||||||||
| |||||||||
href | string | ||||||||
id | string <uuid> | ||||||||
object (Href) | |||||||||
| |||||||||
max_bid_price | number <float> | ||||||||
object (SpotMarketRequest_metro) The metro the spot market request was created in | |||||||||
| |||||||||
object (Href) | |||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "created_at": "2019-08-24T14:15:22Z",
- "devices_max": 0,
- "devices_min": 0,
- "end_at": "2019-08-24T14:15:22Z",
- "facilities": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instances": {
- "href": "string"
}, - "max_bid_price": 0.1,
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "project": {
- "href": "string"
}
}
Userdata Management
Volume Management (Block Storage). Notice: Block storage support will be deprecated soon. Please check here: https://deploy.equinix.com/developers/docs/metal/storage/storage-appliances/ for more details.
Manage BGP configs and sessions. See device endpoints to create and list BGP sessions for a particular device. Check out the product docs to learn more about Local and Global BGP.
Retrieve a BGP session
Returns a BGP session
Authorizations:
path Parameters
id required | string <uuid> BGP session UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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> |
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
Update the BGP session
Updates the BGP session by either enabling or disabling the default route functionality.
Authorizations:
path Parameters
id required | string <uuid> BGP session UUID |
Request Body schema: application/jsonrequired
Default route
Responses
Request samples
- Payload
true
Response samples
- 401
- 403
- 404
- 422
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve a bgp config
Returns a bgp config
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Responses
Response Schema: application/json
asn | integer <int64> [ 0 .. 4294967295 ] Autonomous System Number. ASN is required with Global BGP. With Local BGP the private ASN, 65000, is assigned. | ||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||
deployment_type | string Enum: "global" "local" In a Local BGP deployment, a customer uses an internal ASN to control routes within a single Equinix Metal datacenter. This means that the routes are never advertised to the global Internet. Global BGP, on the other hand, requires a customer to have a registered ASN and IP space. | ||||||||||||||||||
href | string | ||||||||||||||||||
id | string <uuid> | ||||||||||||||||||
max_prefix | integer Default: 10 The maximum number of route filters allowed per server | ||||||||||||||||||
md5 | string or null (Optional) Password for BGP session in plaintext (not a checksum) | ||||||||||||||||||
object (Href) | |||||||||||||||||||
| |||||||||||||||||||
Array of objects (GlobalBgpRange) The IP block ranges associated to the ASN (Populated in Global BGP only) | |||||||||||||||||||
Array
| |||||||||||||||||||
requested_at | string <date-time> | ||||||||||||||||||
route_object | string Specifies AS-MACRO (aka AS-SET) to use when building client route filters | ||||||||||||||||||
Array of objects (BgpSession) The direct connections between neighboring routers that want to exchange routing information. | |||||||||||||||||||
Array
| |||||||||||||||||||
status | string Enum: "requested" "enabled" "disabled" Status of the BGP Config. Status "requested" is valid only with the "global" deployment_type. |
Response samples
- 200
- 401
- 403
- 404
{- "asn": 65000,
- "created_at": "2019-08-24T14:15:22Z",
- "deployment_type": "local",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_prefix": 10,
- "md5": "string",
- "project": {
- "href": "string"
}, - "ranges": [
- {
- "address_family": 0,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "range": "string"
}
], - "requested_at": "2019-08-24T14:15:22Z",
- "route_object": "string",
- "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"
}
], - "status": "requested"
}
Requesting bgp config
Requests to enable bgp configuration for a project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
BGP config Request to create
asn required | integer <int64> [ 0 .. 4294967295 ] Autonomous System Number for local BGP deployment. |
deployment_type required | string Enum: "local" "global" Wether the BGP deployment is local or global. Local deployments are configured immediately. Global deployments will need to be reviewed by Equinix Metal engineers. |
md5 | string^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d]{10,... The plaintext password to share between BGP neighbors as an MD5 checksum:
|
use_case | string A use case explanation (necessary for global BGP request review). |
Responses
Request samples
- Payload
{- "asn": 65000,
- "deployment_type": "local",
- "md5": "string",
- "use_case": "string"
}
Response samples
- 401
- 403
- 404
- 422
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve all BGP sessions for project
Provides a listing of available BGP sessions for the project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
Responses
Response Schema: application/json
Array of objects (BgpSession) | |||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "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"
}
]
}
Retrieve all global bgp ranges
Returns all global bgp ranges for a project
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
Responses
Response Schema: application/json
Array of objects (GlobalBgpRange) | |||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "global_bgp_ranges": [
- {
- "address_family": 0,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "href": "string"
}, - "range": "string"
}
]
}
Network Interconnections. See Instructions to create Network Interconnections at Check out the product docs to learn more about Equinix Fabric.
Get connectivity to network provider by metro
Displays which providers you can connect to directly from Equinix Metal Metros.
Authorizations:
Responses
Response Schema: application/json
Array of objects (InterconnectionMetroList_metros_inner) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 403
- 404
{- "metros": [
- {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "providers": [
- {
- "type": "CSP_AWS",
- "name": "AWS Direct Connect",
- "locations": [
- "us-east-1"
], - "bandwidths": [
- 50
], - "features": [
- "high capacity"
]
}
]
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Get Interconnection Pricing
Displays pricing information for connecting to networks outside of Equinix.
Authorizations:
Responses
Response Schema: application/json
Array of objects (InterconnectionPricingList_provider_pricing_inner) Pricing information per connection provider. | |||||
Array
|
Response samples
- 200
- 403
- 404
{- "provider_pricing": [
- {
- "provider": "CSP_AWS",
- "tiers": [
- {
- "bandwidth": 500,
- "price": 10.04,
- "billing_cycle": "monthly"
}
]
}
]
}
Delete interconnection
Delete a interconnection, its associated ports and virtual circuits.
Authorizations:
path Parameters
connection_id required | string <uuid> Interconnection UUID |
query Parameters
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. |
Responses
Response samples
- 202
- 403
- 404
{- "contact_email": "string",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "mode": "standard",
- "name": "string",
- "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"
}, - "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}
], - "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"
]
}, - "redundancy": "primary",
- "service_tokens": [
- {
- "expires_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_allowed_speed": 10000000000,
- "role": "primary",
- "service_token_type": "a_side",
- "state": "inactive"
}
], - "authorization_code": "string",
- "speed": 10000000000,
- "status": "string",
- "tags": [
- "string"
], - "token": "b5507016-7da2-4777-a161-1e8042a6a377",
- "type": "shared",
- "fabric_provider": {
- "type": "CSP_AWS",
- "account_id": "123412341234",
- "location": "us-west-1"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "requested_by": {
- "href": "string"
}
}
Get interconnection
Get the details of a interconnection
Authorizations:
path Parameters
connection_id required | string <uuid> Interconnection UUID |
query Parameters
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. |
Responses
Response Schema: application/json
contact_email | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Interconnection_metro) The location of where the shared or Dedicated Port is located. For interconnections with Dedicated Ports, this will be the location of the Dedicated Ports. For Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mode | string Enum: "standard" "tunnel" The mode of the interconnection (only relevant to Dedicated Ports). Shared connections won't have this field. Can be either 'standard' or 'tunnel'. The default mode of an interconnection on a Dedicated Port is 'standard'. The mode can only be changed when there are no associated virtual circuits on the interconnection. In tunnel mode, an 802.1q tunnel is added to a port to send/receive double tagged packets from server instances. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Organization) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (InterconnectionPort) For Fabric VCs, these represent Virtual Port(s) created for the interconnection. For dedicated interconnections, these represent the Dedicated Port(s). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redundancy | string Enum: "primary" "redundant" Either 'primary', meaning a single interconnection, or 'redundant', meaning a redundant interconnection. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (FabricServiceToken) For Fabric VCs (Metal Billed), this will show details of the A-Side service tokens issued for the interconnection. For Fabric VCs (Fabric Billed), this will show the details of the Z-Side service tokens issued for the interconnection. Dedicated interconnections will not have any service tokens issued. There will be one per interconnection, so for redundant interconnections, there should be two service tokens issued. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authorization_code | string For Fabric VCs (Metal Billed), this allows Fabric to connect the Metal network to any connection Fabric facilitates. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed | integer <int64> For interconnections on Dedicated Ports and shared connections, this represents the interconnection's speed in bps. For Fabric VCs, this field refers to the maximum speed of the interconnection in bps. This value will default to 10Gbps for Fabric VCs (Fabric Billed). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
token | string <uuid> This token is used for shared interconnections to be used as the Fabric Token. This field is entirely deprecated. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "shared" "dedicated" "shared_port_vlan" "shared_port_vlan_to_csp" The 'shared' type of interconnection refers to shared connections, or later also known as Fabric Virtual Connections (or Fabric VCs). The 'dedicated' type of interconnection refers to interconnections created with Dedicated Ports. The 'shared_port_vlan' type of interconnection refers to shared connections created without service tokens. The 'shared_port_vlan_to_csp' type of interconnection refers to connections created directly to a supported cloud service provider. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AWSFabricProvider (object) (Interconnection_fabric_provider) Configuration information for connecting to external cloud service provider. Only available if the fabric_provider param was used when creating the interconnection. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 403
- 404
{- "contact_email": "string",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "mode": "standard",
- "name": "string",
- "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"
}, - "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}
], - "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"
]
}, - "redundancy": "primary",
- "service_tokens": [
- {
- "expires_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_allowed_speed": 10000000000,
- "role": "primary",
- "service_token_type": "a_side",
- "state": "inactive"
}
], - "authorization_code": "string",
- "speed": 10000000000,
- "status": "string",
- "tags": [
- "string"
], - "token": "b5507016-7da2-4777-a161-1e8042a6a377",
- "type": "shared",
- "fabric_provider": {
- "type": "CSP_AWS",
- "account_id": "123412341234",
- "location": "us-west-1"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "requested_by": {
- "href": "string"
}
}
Update interconnection
Update the details of a interconnection
Authorizations:
path Parameters
connection_id required | string <uuid> Interconnection UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Updated interconnection details
contact_email | string |
description | string |
mode | string Enum: "standard" "tunnel" The mode of the interconnection (only relevant to Dedicated Ports). Shared connections won't have this field. Can be either 'standard' or 'tunnel'. The default mode of an interconnection on a Dedicated Port is 'standard'. The mode can only be changed when there are no associated virtual circuits on the interconnection. In tunnel mode, an 802.1q tunnel is added to a port to send/receive double tagged packets from server instances. |
name | string |
tags | Array of strings |
Responses
Response Schema: application/json
contact_email | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Interconnection_metro) The location of where the shared or Dedicated Port is located. For interconnections with Dedicated Ports, this will be the location of the Dedicated Ports. For Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mode | string Enum: "standard" "tunnel" The mode of the interconnection (only relevant to Dedicated Ports). Shared connections won't have this field. Can be either 'standard' or 'tunnel'. The default mode of an interconnection on a Dedicated Port is 'standard'. The mode can only be changed when there are no associated virtual circuits on the interconnection. In tunnel mode, an 802.1q tunnel is added to a port to send/receive double tagged packets from server instances. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Organization) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (InterconnectionPort) For Fabric VCs, these represent Virtual Port(s) created for the interconnection. For dedicated interconnections, these represent the Dedicated Port(s). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redundancy | string Enum: "primary" "redundant" Either 'primary', meaning a single interconnection, or 'redundant', meaning a redundant interconnection. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (FabricServiceToken) For Fabric VCs (Metal Billed), this will show details of the A-Side service tokens issued for the interconnection. For Fabric VCs (Fabric Billed), this will show the details of the Z-Side service tokens issued for the interconnection. Dedicated interconnections will not have any service tokens issued. There will be one per interconnection, so for redundant interconnections, there should be two service tokens issued. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authorization_code | string For Fabric VCs (Metal Billed), this allows Fabric to connect the Metal network to any connection Fabric facilitates. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed | integer <int64> For interconnections on Dedicated Ports and shared connections, this represents the interconnection's speed in bps. For Fabric VCs, this field refers to the maximum speed of the interconnection in bps. This value will default to 10Gbps for Fabric VCs (Fabric Billed). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
token | string <uuid> This token is used for shared interconnections to be used as the Fabric Token. This field is entirely deprecated. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "shared" "dedicated" "shared_port_vlan" "shared_port_vlan_to_csp" The 'shared' type of interconnection refers to shared connections, or later also known as Fabric Virtual Connections (or Fabric VCs). The 'dedicated' type of interconnection refers to interconnections created with Dedicated Ports. The 'shared_port_vlan' type of interconnection refers to shared connections created without service tokens. The 'shared_port_vlan_to_csp' type of interconnection refers to connections created directly to a supported cloud service provider. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AWSFabricProvider (object) (Interconnection_fabric_provider) Configuration information for connecting to external cloud service provider. Only available if the fabric_provider param was used when creating the interconnection. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Request samples
- Payload
{- "contact_email": "string",
- "description": "string",
- "mode": "standard",
- "name": "string",
- "tags": [
- "string"
]
}
Response samples
- 200
- 403
- 404
{- "contact_email": "string",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "mode": "standard",
- "name": "string",
- "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"
}, - "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}
], - "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"
]
}, - "redundancy": "primary",
- "service_tokens": [
- {
- "expires_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_allowed_speed": 10000000000,
- "role": "primary",
- "service_token_type": "a_side",
- "state": "inactive"
}
], - "authorization_code": "string",
- "speed": 10000000000,
- "status": "string",
- "tags": [
- "string"
], - "token": "b5507016-7da2-4777-a161-1e8042a6a377",
- "type": "shared",
- "fabric_provider": {
- "type": "CSP_AWS",
- "account_id": "123412341234",
- "location": "us-west-1"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "requested_by": {
- "href": "string"
}
}
List a interconnection's ports
List the ports associated to an interconnection.
Authorizations:
path Parameters
connection_id required | string <uuid> UUID of the interconnection |
Responses
Response Schema: application/json
Array of objects (InterconnectionPort) | |||||||||||||||||||||
Array
|
Response samples
- 200
- 403
- 404
{- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}
]
}
List a interconnection's virtual circuits
List the virtual circuit record(s) associated with a particular interconnection id.
Authorizations:
path Parameters
connection_id required | string <uuid> UUID of the interconnection |
Responses
Response Schema: application/json
Array of VlanVirtualCircuit (object) or VrfVirtualCircuit (object) (VirtualCircuit) | |||||||||||||||||||||||||||||||||||
Array One of
|
Response samples
- 200
- 403
- 404
{- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- null
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get a interconnection port
Get the details of an interconnection port.
Authorizations:
path Parameters
connection_id required | string <uuid> UUID of the interconnection |
id required | string <uuid> Port UUID |
query Parameters
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. |
Responses
Response Schema: application/json
id | string <uuid> | ||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
role | string Enum: "primary" "secondary" Either 'primary' or 'secondary'. | ||||||||||||||||||||||||||||||||||
status | string Enum: "requested" "active" "deleting" "expired" "delete_failed" For both Fabric VCs and Dedicated Ports, this will be 'requested' on creation and 'deleting' on deletion. Once the Fabric VC has found its corresponding Fabric connection, this will turn to 'active'. For Dedicated Ports, once the dedicated port is associated, this will also turn to 'active'. For Fabric VCs, this can turn into an 'expired' state if the service token associated is expired. | ||||||||||||||||||||||||||||||||||
switch_id | string A switch 'short ID' | ||||||||||||||||||||||||||||||||||
Array of VlanVirtualCircuit (object) or VrfVirtualCircuit (object) (VirtualCircuit) | |||||||||||||||||||||||||||||||||||
Array One of
| |||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||
speed | integer <int64> | ||||||||||||||||||||||||||||||||||
link_status | string | ||||||||||||||||||||||||||||||||||
href | string |
Response samples
- 200
- 403
- 404
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}
List a interconnection port's virtual circuits
List the virtual circuit record(s) associatiated with a particular interconnection port.
Authorizations:
path Parameters
connection_id required | string <uuid> UUID of the interconnection |
port_id required | string <uuid> UUID of the interconnection port |
query Parameters
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. |
Responses
Response Schema: application/json
Array of VlanVirtualCircuit (object) or VrfVirtualCircuit (object) (VirtualCircuit) | |||||||||||||||||||||||||||||||||||
Array One of
|
Response samples
- 200
- 403
- 404
{- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- null
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Create a new Virtual Circuit
Create a new Virtual Circuit on a Dedicated Port. To create a regular Virtual Circuit, specify a Virtual Network record and an NNI VLAN value. To create a VRF-based Virtual Circuit, specify the VRF ID and subnet, along with the NNI VLAN value.
Authorizations:
path Parameters
connection_id required | string <uuid> UUID of the interconnection |
port_id required | string <uuid> UUID of the interconnection port |
Request Body schema: application/jsonrequired
Virtual Circuit details
description | string |
name | string |
nni_vlan | integer [ 2 .. 4094 ] |
project_id required | string <uuid> |
speed | string speed can be passed as integer number representing bps speed or string (e.g. '52m' or '100g' or '4 gbps') |
tags | Array of strings |
vnid | string <uuid> A Virtual Network record UUID or the VNID of a Metro Virtual Network in your project (sent as integer). |
Responses
Response Schema: application/json
bill | boolean Default: false True if the Virtual Circuit is being billed. Currently, only Virtual Circuits of Fabric VCs (Metal Billed) will be billed. Usage will start the first time the Virtual Circuit becomes active, and will not stop until it is deleted from Metal. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bill_type | string or null Enum: "metal_billed" "fabric_billed" Fabric Billed if the Virtual Circuit is billed by Fabric. Metal Billed if the Virtual Circuit is billed by Metal. Legacy Virtual Circuits will have a value of nil. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nni_vlan | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (InterconnectionPort) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed | integer <int64> For Virtual Circuits on shared and dedicated connections, this speed should match the one set on their Interconnection Ports. For Virtual Circuits on Fabric VCs (both Metal and Fabric Billed) that have found their corresponding Fabric connection, this is the actual speed of the interconnection that was configured when setting up the interconnection on the Fabric Portal. Details on Fabric VCs are included in the specification as a developer preview and is generally unavailable. Please contact our Support team for more details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "waiting_on_customer_vlan" "activating" "changing_vlan" "deactivating" "deleting" "active" "expired" "activation_failed" "changing_vlan_failed" "deactivation_failed" "delete_failed" "configure_fabric_routing_protocols" The status of a Virtual Circuit is always 'pending' on creation. The status can turn to 'Waiting on Customer VLAN' if a Metro VLAN was not set yet on the Virtual Circuit and is the last step needed for full activation. For Dedicated interconnections, as long as the Dedicated Port has been associated to the Virtual Circuit and a NNI VNID has been set, it will turn to 'waiting_on_customer_vlan'. For Fabric VCs, it will only change to 'waiting_on_customer_vlan' once the corresponding Fabric connection has been found on the Fabric side. If the Fabric service token associated with the Virtual Circuit hasn't been redeemed on Fabric within the expiry time, it will change to an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_connection_id | string This field is relevant if using the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "vlan" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vnid | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> |
Request samples
- Payload
{- "description": "string",
- "name": "string",
- "nni_vlan": 2,
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "speed": "string",
- "tags": [
- "string"
], - "vnid": "0204c0b4-6efb-483f-aab4-f8d7b4151888"
}
Response samples
- 201
- 403
- 404
{- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": null,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
List an Organization's interconnections
Returns a list of the interconnections belonging to the Organization.
Authorizations:
path Parameters
organization_id required | string <uuid> UUID of the organization |
query Parameters
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={project_id} | string <uuid> Filter the list to return only the interconnections for the specified Project. |
Responses
Response Schema: application/json
Array of objects (Interconnection) | |||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 403
- 404
{- "interconnections": [
- {
- "contact_email": "string",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "mode": "standard",
- "name": "string",
- "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"
}, - "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}
], - "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"
]
}, - "redundancy": "primary",
- "service_tokens": [
- {
- "expires_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_allowed_speed": 10000000000,
- "role": "primary",
- "service_token_type": "a_side",
- "state": "inactive"
}
], - "authorization_code": "string",
- "speed": 10000000000,
- "status": "string",
- "tags": [
- "string"
], - "token": "b5507016-7da2-4777-a161-1e8042a6a377",
- "type": "shared",
- "fabric_provider": {
- "type": "CSP_AWS",
- "account_id": "123412341234",
- "location": "us-west-1"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "requested_by": {
- "href": "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
}
}
Request a new interconnection for the organization
Creates a new interconnection request. A Project ID must be specified in the request body for connections on shared ports.
Authorizations:
path Parameters
organization_id required | string <uuid> UUID of the organization |
query Parameters
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. |
Request Body schema: application/jsonrequired
Dedicated port or shared interconnection (also known as Fabric VC) creation request.
Shared interconnections can be created with the following request types:
VlanCSPConnectionCreateInput
creates a layer 2 interconnection directly to your Cloud Service Provider.SharedPortVCVlanCreateInput
creates a layer 2 interconnection that you can finish configuration in Fabric. For new connections, this type is preferred toVlanFabricVCCreateInput
.VlanFabricVCCreateInput
creates a layer 2 interconnection that you can connect through Fabric with a service token.VrfFabricVCCreateInput
creates a layer 3 interconnection that you can connect through Fabric with a service token.
billing_account_name | string The billing account name of the Equinix Fabric account. |
contact_email | string <email> The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. |
description | string |
metro required | string A Metro ID or code. For interconnections with Dedicated Ports, this will be the location of the issued Dedicated Ports. |
mode | string Enum: "standard" "tunnel" The mode of the interconnection (only relevant to Dedicated Ports). Fabric VCs won't have this field. Can be either 'standard' or 'tunnel'. The default mode of an interconnection on a Dedicated Port is 'standard'. The mode can only be changed when there are no associated virtual circuits on the interconnection. In tunnel mode, an 802.1q tunnel is added to a port to send/receive double tagged packets from server instances. |
name required | string |
project | string |
redundancy required | string Either 'primary' or 'redundant'. |
speed | string A interconnection speed, in bps, mbps, or gbps. For Dedicated Ports, this can be 10Gbps or 100Gbps. |
tags | Array of strings |
type required | string Value: "dedicated" When requesting for a dedicated port, the value of this field should be 'dedicated'. |
use_case | string The intended use case of the dedicated port. |
Responses
Response Schema: application/json
contact_email | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Interconnection_metro) The location of where the shared or Dedicated Port is located. For interconnections with Dedicated Ports, this will be the location of the Dedicated Ports. For Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mode | string Enum: "standard" "tunnel" The mode of the interconnection (only relevant to Dedicated Ports). Shared connections won't have this field. Can be either 'standard' or 'tunnel'. The default mode of an interconnection on a Dedicated Port is 'standard'. The mode can only be changed when there are no associated virtual circuits on the interconnection. In tunnel mode, an 802.1q tunnel is added to a port to send/receive double tagged packets from server instances. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Organization) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (InterconnectionPort) For Fabric VCs, these represent Virtual Port(s) created for the interconnection. For dedicated interconnections, these represent the Dedicated Port(s). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redundancy | string Enum: "primary" "redundant" Either 'primary', meaning a single interconnection, or 'redundant', meaning a redundant interconnection. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (FabricServiceToken) For Fabric VCs (Metal Billed), this will show details of the A-Side service tokens issued for the interconnection. For Fabric VCs (Fabric Billed), this will show the details of the Z-Side service tokens issued for the interconnection. Dedicated interconnections will not have any service tokens issued. There will be one per interconnection, so for redundant interconnections, there should be two service tokens issued. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authorization_code | string For Fabric VCs (Metal Billed), this allows Fabric to connect the Metal network to any connection Fabric facilitates. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed | integer <int64> For interconnections on Dedicated Ports and shared connections, this represents the interconnection's speed in bps. For Fabric VCs, this field refers to the maximum speed of the interconnection in bps. This value will default to 10Gbps for Fabric VCs (Fabric Billed). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
token | string <uuid> This token is used for shared interconnections to be used as the Fabric Token. This field is entirely deprecated. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "shared" "dedicated" "shared_port_vlan" "shared_port_vlan_to_csp" The 'shared' type of interconnection refers to shared connections, or later also known as Fabric Virtual Connections (or Fabric VCs). The 'dedicated' type of interconnection refers to interconnections created with Dedicated Ports. The 'shared_port_vlan' type of interconnection refers to shared connections created without service tokens. The 'shared_port_vlan_to_csp' type of interconnection refers to connections created directly to a supported cloud service provider. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AWSFabricProvider (object) (Interconnection_fabric_provider) Configuration information for connecting to external cloud service provider. Only available if the fabric_provider param was used when creating the interconnection. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Request samples
- Payload
{- "billing_account_name": "string",
- "contact_email": "user@example.com",
- "description": "string",
- "metro": "string",
- "mode": "standard",
- "name": "string",
- "project": "string",
- "redundancy": "string",
- "speed": "10000000000",
- "tags": [
- "string"
], - "type": "dedicated",
- "use_case": "string"
}
Response samples
- 201
- 403
- 404
- 422
{- "contact_email": "string",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "mode": "standard",
- "name": "string",
- "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"
}, - "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}
], - "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"
]
}, - "redundancy": "primary",
- "service_tokens": [
- {
- "expires_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_allowed_speed": 10000000000,
- "role": "primary",
- "service_token_type": "a_side",
- "state": "inactive"
}
], - "authorization_code": "string",
- "speed": 10000000000,
- "status": "string",
- "tags": [
- "string"
], - "token": "b5507016-7da2-4777-a161-1e8042a6a377",
- "type": "shared",
- "fabric_provider": {
- "type": "CSP_AWS",
- "account_id": "123412341234",
- "location": "us-west-1"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "requested_by": {
- "href": "string"
}
}
List a Project's and Organization's interconnections
Returns a List of all the interconnections in an Organization, including the interconnections in the specified Project. To reliably get a list of interconnections filtered to just the interconnections accessible to the specified Project, use the /organizations/{organization_id}/interconnections?project={project_id}
endpoint, filtering on the Project ID.
Authorizations:
path Parameters
project_id required | string <uuid> UUID of the project |
query Parameters
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 |
Responses
Response Schema: application/json
Array of objects (Interconnection) | |||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 403
- 404
{- "interconnections": [
- {
- "contact_email": "string",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "mode": "standard",
- "name": "string",
- "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"
}, - "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}
], - "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"
]
}, - "redundancy": "primary",
- "service_tokens": [
- {
- "expires_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_allowed_speed": 10000000000,
- "role": "primary",
- "service_token_type": "a_side",
- "state": "inactive"
}
], - "authorization_code": "string",
- "speed": 10000000000,
- "status": "string",
- "tags": [
- "string"
], - "token": "b5507016-7da2-4777-a161-1e8042a6a377",
- "type": "shared",
- "fabric_provider": {
- "type": "CSP_AWS",
- "account_id": "123412341234",
- "location": "us-west-1"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "requested_by": {
- "href": "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
}
}
Request a new interconnection for the project's organization
Creates a new interconnection request
Authorizations:
path Parameters
project_id required | string <uuid> UUID of the project |
query Parameters
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. |
Request Body schema: application/jsonrequired
Dedicated port or shared interconnection (also known as Fabric VC) creation request.
Shared interconnections can be created with the following request types:
VlanCSPConnectionCreateInput
creates a layer 2 interconnection directly to your Cloud Service Provider.SharedPortVCVlanCreateInput
creates a layer 2 interconnection that you can finish configuration in Fabric. For new connections, this type is preferred toVlanFabricVCCreateInput
.VlanFabricVCCreateInput
creates a layer 2 interconnection that you can connect through Fabric with a service token.VrfFabricVCCreateInput
creates a layer 3 interconnection that you can connect through Fabric with a service token.
billing_account_name | string The billing account name of the Equinix Fabric account. |
contact_email | string <email> The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. |
description | string |
metro required | string A Metro ID or code. For interconnections with Dedicated Ports, this will be the location of the issued Dedicated Ports. |
mode | string Enum: "standard" "tunnel" The mode of the interconnection (only relevant to Dedicated Ports). Fabric VCs won't have this field. Can be either 'standard' or 'tunnel'. The default mode of an interconnection on a Dedicated Port is 'standard'. The mode can only be changed when there are no associated virtual circuits on the interconnection. In tunnel mode, an 802.1q tunnel is added to a port to send/receive double tagged packets from server instances. |
name required | string |
project | string |
redundancy required | string Either 'primary' or 'redundant'. |
speed | string A interconnection speed, in bps, mbps, or gbps. For Dedicated Ports, this can be 10Gbps or 100Gbps. |
tags | Array of strings |
type required | string Value: "dedicated" When requesting for a dedicated port, the value of this field should be 'dedicated'. |
use_case | string The intended use case of the dedicated port. |
Responses
Response Schema: application/json
contact_email | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Interconnection_metro) The location of where the shared or Dedicated Port is located. For interconnections with Dedicated Ports, this will be the location of the Dedicated Ports. For Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mode | string Enum: "standard" "tunnel" The mode of the interconnection (only relevant to Dedicated Ports). Shared connections won't have this field. Can be either 'standard' or 'tunnel'. The default mode of an interconnection on a Dedicated Port is 'standard'. The mode can only be changed when there are no associated virtual circuits on the interconnection. In tunnel mode, an 802.1q tunnel is added to a port to send/receive double tagged packets from server instances. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Organization) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (InterconnectionPort) For Fabric VCs, these represent Virtual Port(s) created for the interconnection. For dedicated interconnections, these represent the Dedicated Port(s). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redundancy | string Enum: "primary" "redundant" Either 'primary', meaning a single interconnection, or 'redundant', meaning a redundant interconnection. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (FabricServiceToken) For Fabric VCs (Metal Billed), this will show details of the A-Side service tokens issued for the interconnection. For Fabric VCs (Fabric Billed), this will show the details of the Z-Side service tokens issued for the interconnection. Dedicated interconnections will not have any service tokens issued. There will be one per interconnection, so for redundant interconnections, there should be two service tokens issued. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authorization_code | string For Fabric VCs (Metal Billed), this allows Fabric to connect the Metal network to any connection Fabric facilitates. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed | integer <int64> For interconnections on Dedicated Ports and shared connections, this represents the interconnection's speed in bps. For Fabric VCs, this field refers to the maximum speed of the interconnection in bps. This value will default to 10Gbps for Fabric VCs (Fabric Billed). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
token | string <uuid> This token is used for shared interconnections to be used as the Fabric Token. This field is entirely deprecated. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Enum: "shared" "dedicated" "shared_port_vlan" "shared_port_vlan_to_csp" The 'shared' type of interconnection refers to shared connections, or later also known as Fabric Virtual Connections (or Fabric VCs). The 'dedicated' type of interconnection refers to interconnections created with Dedicated Ports. The 'shared_port_vlan' type of interconnection refers to shared connections created without service tokens. The 'shared_port_vlan_to_csp' type of interconnection refers to connections created directly to a supported cloud service provider. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AWSFabricProvider (object) (Interconnection_fabric_provider) Configuration information for connecting to external cloud service provider. Only available if the fabric_provider param was used when creating the interconnection. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Request samples
- Payload
{- "billing_account_name": "string",
- "contact_email": "user@example.com",
- "description": "string",
- "metro": "string",
- "mode": "standard",
- "name": "string",
- "project": "string",
- "redundancy": "string",
- "speed": "10000000000",
- "tags": [
- "string"
], - "type": "dedicated",
- "use_case": "string"
}
Response samples
- 201
- 403
- 422
{- "contact_email": "string",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "mode": "standard",
- "name": "string",
- "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"
}, - "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}
], - "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"
]
}, - "redundancy": "primary",
- "service_tokens": [
- {
- "expires_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_allowed_speed": 10000000000,
- "role": "primary",
- "service_token_type": "a_side",
- "state": "inactive"
}
], - "authorization_code": "string",
- "speed": 10000000000,
- "status": "string",
- "tags": [
- "string"
], - "token": "b5507016-7da2-4777-a161-1e8042a6a377",
- "type": "shared",
- "fabric_provider": {
- "type": "CSP_AWS",
- "account_id": "123412341234",
- "location": "us-west-1"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "requested_by": {
- "href": "string"
}
}
Delete a virtual circuit
Delete a virtual circuit from a Dedicated Port.
Authorizations:
path Parameters
id required | string <uuid> Virtual Circuit UUID |
query Parameters
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. |
Responses
Response samples
- 202
- 403
- 404
{- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": null,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get a virtual circuit
Get the details of a virtual circuit
Authorizations:
path Parameters
id required | string <uuid> Virtual Circuit UUID |
query Parameters
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. |
Responses
Response Schema: application/json
bill | boolean Default: false True if the Virtual Circuit is being billed. Currently, only Virtual Circuits of Fabric VCs (Metal Billed) will be billed. Usage will start the first time the Virtual Circuit becomes active, and will not stop until it is deleted from Metal. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bill_type | string or null Enum: "metal_billed" "fabric_billed" Fabric Billed if the Virtual Circuit is billed by Fabric. Metal Billed if the Virtual Circuit is billed by Metal. Legacy Virtual Circuits will have a value of nil. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nni_vlan | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (InterconnectionPort) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed | integer <int64> For Virtual Circuits on shared and dedicated connections, this speed should match the one set on their Interconnection Ports. For Virtual Circuits on Fabric VCs (both Metal and Fabric Billed) that have found their corresponding Fabric connection, this is the actual speed of the interconnection that was configured when setting up the interconnection on the Fabric Portal. Details on Fabric VCs are included in the specification as a developer preview and is generally unavailable. Please contact our Support team for more details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "waiting_on_customer_vlan" "activating" "changing_vlan" "deactivating" "deleting" "active" "expired" "activation_failed" "changing_vlan_failed" "deactivation_failed" "delete_failed" "configure_fabric_routing_protocols" The status of a Virtual Circuit is always 'pending' on creation. The status can turn to 'Waiting on Customer VLAN' if a Metro VLAN was not set yet on the Virtual Circuit and is the last step needed for full activation. For Dedicated interconnections, as long as the Dedicated Port has been associated to the Virtual Circuit and a NNI VNID has been set, it will turn to 'waiting_on_customer_vlan'. For Fabric VCs, it will only change to 'waiting_on_customer_vlan' once the corresponding Fabric connection has been found on the Fabric side. If the Fabric service token associated with the Virtual Circuit hasn't been redeemed on Fabric within the expiry time, it will change to an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_connection_id | string This field is relevant if using the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "vlan" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vnid | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> |
Response samples
- 200
- 403
- 404
{- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": null,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Update a virtual circuit
Update the details of a virtual circuit.
Authorizations:
path Parameters
id required | string <uuid> Virtual Circuit UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Updated Virtual Circuit details
description | string |
name | string |
speed | string Speed can be changed only if it is an interconnection on a Dedicated Port |
tags | Array of strings |
vnid | string A Virtual Network record UUID or the VNID of a Metro Virtual Network in your project. |
Responses
Response Schema: application/json
bill | boolean Default: false True if the Virtual Circuit is being billed. Currently, only Virtual Circuits of Fabric VCs (Metal Billed) will be billed. Usage will start the first time the Virtual Circuit becomes active, and will not stop until it is deleted from Metal. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bill_type | string or null Enum: "metal_billed" "fabric_billed" Fabric Billed if the Virtual Circuit is billed by Fabric. Metal Billed if the Virtual Circuit is billed by Metal. Legacy Virtual Circuits will have a value of nil. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nni_vlan | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (InterconnectionPort) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed | integer <int64> For Virtual Circuits on shared and dedicated connections, this speed should match the one set on their Interconnection Ports. For Virtual Circuits on Fabric VCs (both Metal and Fabric Billed) that have found their corresponding Fabric connection, this is the actual speed of the interconnection that was configured when setting up the interconnection on the Fabric Portal. Details on Fabric VCs are included in the specification as a developer preview and is generally unavailable. Please contact our Support team for more details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "waiting_on_customer_vlan" "activating" "changing_vlan" "deactivating" "deleting" "active" "expired" "activation_failed" "changing_vlan_failed" "deactivation_failed" "delete_failed" "configure_fabric_routing_protocols" The status of a Virtual Circuit is always 'pending' on creation. The status can turn to 'Waiting on Customer VLAN' if a Metro VLAN was not set yet on the Virtual Circuit and is the last step needed for full activation. For Dedicated interconnections, as long as the Dedicated Port has been associated to the Virtual Circuit and a NNI VNID has been set, it will turn to 'waiting_on_customer_vlan'. For Fabric VCs, it will only change to 'waiting_on_customer_vlan' once the corresponding Fabric connection has been found on the Fabric side. If the Fabric service token associated with the Virtual Circuit hasn't been redeemed on Fabric within the expiry time, it will change to an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_connection_id | string This field is relevant if using the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "vlan" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vnid | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> |
Request samples
- Payload
{- "description": "string",
- "name": "string",
- "speed": "string",
- "tags": [
- "string"
], - "vnid": "string"
}
Response samples
- 200
- 202
- 403
- 404
{- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": null,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Manage IP addresses. See device and project endpoints to list and create IP assignments for a particular project or device. Check out the product docs to learn more about the basic networking features.
Unassign an ip address
This call can be used to un-assign an IP assignment or delete an IP reservation.
Un-assign an IP address record. Use the assignment UUID you get after attaching the IP. This will remove the relationship between an IP and the device or metal gateway and will make the IP address available to be assigned to another device, once the IP has been un-configured from the network.
Delete an IP reservation. Use the reservation UUID you get after adding the IP to the project. This will permanently delete the IP block reservation from the project.
Authorizations:
path Parameters
id required | string <uuid> IP Address UUID |
Responses
Response samples
- 401
- 403
- 404
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve an ip address
Returns a single ip address if the user has access.
Authorizations:
path Parameters
id required | string <uuid> IP Address UUID |
query Parameters
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. |
Responses
Response Schema: application/json
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. |
Response samples
- 200
- 401
- 403
- 404
{- "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"
}
Update an ip address
Update details about an ip address
Authorizations:
path Parameters
id required | string <uuid> IP Address UUID |
query Parameters
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. |
Request Body schema: application/json
details | string |
customdata | object |
tags | Array of strings |
Responses
Response Schema: application/json
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. |
Request samples
- Payload
{- "details": "string",
- "customdata": { },
- "tags": [
- "string"
]
}
Response samples
- 200
- 401
- 403
- 404
{- "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 all available subnets of a particular reservation
Provides a list of IP resevations for a single project.
Authorizations:
path Parameters
id required | string <uuid> IP Reservation UUID |
query Parameters
cidr required | string Enum: "20" "21" "22" "23" "24" "25" "26" "27" "28" "29" "30" "31" "32" "33" "34" "35" "36" "37" "38" "39" "40" "41" "42" "43" "44" "45" "46" "47" "48" "49" "50" "51" "52" "53" "54" "55" "56" "57" "58" "59" "60" "61" "62" "63" "64" "65" "66" "67" "68" "69" "70" "71" "72" "73" "74" "75" "76" "77" "78" "79" "80" "81" "82" "83" "84" "85" "86" "87" "88" "89" "90" "91" "92" "93" "94" "95" "96" "97" "98" "99" "100" "101" "102" "103" "104" "105" "106" "107" "108" "109" "110" "111" "112" "113" "114" "115" "116" "117" "118" "119" "120" "121" "122" "123" "124" "125" "126" "127" "128" Size of subnets in bits |
Responses
Response Schema: application/json
available | Array of strings |
Response samples
- 200
- 401
- 403
- 404
{- "available": [
- "string"
]
}
Retrieve the custom metadata of an IP Reservation or IP Assignment
Provides the custom metadata stored for this IP Reservation or IP Assignment in json format
Authorizations:
path Parameters
id required | string <uuid> Ip Reservation UUID |
Responses
Response samples
- 401
- 403
- 404
{- "error": "string",
- "errors": [
- "string"
]
}
Retrieve all ip reservations
Provides a paginated list of IP reservations for a single project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
types | Array of strings Items Enum: "global_ipv4" "private_ipv4" "public_ipv4" "public_ipv6" "vrf" Filter project IP reservations by reservation type |
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. |
per_page | integer <int32> [ 1 .. 1000 ] Default: 250 Items returned per page |
Responses
Response Schema: application/json
Array of IPReservation (object) or VrfIpReservation (object) (IPReservationList_ip_addresses_inner) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array Any of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 403
- 404
{- "ip_addresses": [
- {
- "addon": true,
- "address": "string",
- "address_family": 0,
- "assignments": [
- {
- "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"
}
], - "available": "string",
- "bill": true,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "enabled": true,
- "details": "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"
}, - "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metal_gateway": {
- "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"
}, - "netmask": "string",
- "network": "string",
- "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"
}, - "requested_by": {
- "href": "string"
}, - "public": true,
- "state": "string",
- "tags": [
- "string"
], - "type": "global_ipv4"
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Requesting IP reservations
Request more IP space for a project in order to have additional IP addresses to assign to devices. If the request is within the max quota, an IP reservation will be created. If the project will exceed its IP quota, a request will be submitted for review, and will return an IP Reservation with a state
of pending
. You can automatically have the request fail with HTTP status 422 instead of triggering the review process by providing the fail_on_approval_required
parameter set to true
in the request.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
IP Reservation Request to create
comments | string |
customdata | object |
details | string |
facility | string |
fail_on_approval_required | boolean |
metro | string The code of the metro you are requesting the IP reservation in. |
quantity required | integer |
tags | Array of strings |
type required | string |
Responses
Response Schema: application/json
addon | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
address | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
address_family | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (IPAssignment) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
available | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bill | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cidr | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customdata | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enabled | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
details | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (IPReservation_facility) The facility the IP reservation is in. If the facility the IP reservation was requested in is in a metro, a metro value will also be set, and the subsequent IP reservation can be used on a metro level. Can be null if requesting an IP reservation in a metro. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gateway | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
global_ip | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manageable | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
management | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (MetalGatewayLite) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (IPReservation_metro) The metro the IP reservation is in. As long as the IP reservation has a metro, it can be used on a metro level. Can be null if requesting an IP reservation in a facility that is not in a metro. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
netmask | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type required | string Enum: "global_ipv4" "public_ipv4" "private_ipv4" "public_ipv6" |
Request samples
- Payload
{- "comments": "string",
- "customdata": { },
- "details": "string",
- "facility": "string",
- "fail_on_approval_required": true,
- "metro": "SV",
- "quantity": 0,
- "tags": [
- "string"
], - "type": "string"
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "addon": true,
- "address": "string",
- "address_family": 0,
- "assignments": [
- {
- "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"
}
], - "available": "string",
- "bill": true,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "enabled": true,
- "details": "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"
}, - "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metal_gateway": {
- "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"
}, - "netmask": "string",
- "network": "string",
- "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"
}, - "requested_by": {
- "href": "string"
}, - "public": true,
- "state": "string",
- "tags": [
- "string"
], - "type": "global_ipv4"
}
Metal Gateway Management.Check out the product docs to learn more about Metal Gateways.
Deletes the metal gateway
Deletes a metal gateway and any elastic IP assignments associated with this metal gateway.
Authorizations:
path Parameters
id required | string <uuid> Metal Gateway UUID |
query Parameters
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. |
Responses
Response samples
- 202
- 401
- 404
{- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "addon": true,
- "address": "string",
- "address_family": 0,
- "assignments": [
- {
- "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"
}
], - "available": "string",
- "bill": true,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "enabled": true,
- "details": "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"
}, - "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metal_gateway": {
- "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"
}, - "netmask": "string",
- "network": "string",
- "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"
}, - "requested_by": {
- "href": "string"
}, - "public": true,
- "state": "string",
- "tags": [
- "string"
], - "type": "global_ipv4"
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}
}
Returns the metal gateway
Returns a specific metal gateway
Authorizations:
path Parameters
id required | string <uuid> Metal Gateway UUID |
query Parameters
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. |
Responses
Response Schema: application/json
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (IPReservation) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "ready" "active" "deleting" The current state of the Metal Gateway. 'Ready' indicates the gateway record has been configured, but is currently not active on the network. 'Active' indicates the gateway has been configured on the network. 'Deleting' is a temporary state used to indicate that the gateway is in the process of being un-configured from the network, after which the gateway record will be deleted. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 404
{- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "addon": true,
- "address": "string",
- "address_family": 0,
- "assignments": [
- {
- "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"
}
], - "available": "string",
- "bill": true,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "enabled": true,
- "details": "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"
}, - "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metal_gateway": {
- "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"
}, - "netmask": "string",
- "network": "string",
- "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"
}, - "requested_by": {
- "href": "string"
}, - "public": true,
- "state": "string",
- "tags": [
- "string"
], - "type": "global_ipv4"
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}
}
List BGP Dynamic Neighbors
Returns the list of VRF BGP Dynamic Neighbors for this Metal Gateway
Authorizations:
path Parameters
id required | string <uuid> Metal Gateway UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (BgpDynamicNeighbor) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 404
{- "bgp_dynamic_neighbors": [
- {
- "id": "aea82f16-57ec-412c-9523-b7f2b27635b2",
- "bgp_neighbor_asn": 12345,
- "bgp_neighbor_range": "192.168.1.0/25",
- "metal_gateway": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": null
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- null
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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": 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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null,
- "longitude": null
}, - "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": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "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": null,
- "country": null,
- "id": null,
- "name": null
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- null
], - "available_in_metros": [
- null
], - "categories": [
- null
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- null
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [ ],
- "memory": null,
- "drives": [ ],
- "nics": [ ],
- "features": null
}, - "type": "standard"
}, - "project": {
- "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
]
}, - "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": null
}, - "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": null,
- "country": null,
- "id": null,
- "name": null
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": null,
- "href": null,
- "netmask": null,
- "network": null
}, - "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": null,
- "name": null
}, - "data": {
- "mac": null,
- "bonded": null
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": { },
- "virtual_networks": [
- null
]
}
], - "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": null,
- "price": null
}
], - "available_in_metros": [
- {
- "href": null,
- "price": null
}
], - "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": [
- null
], - "memory": {
- "total": null
}, - "drives": [
- null
], - "nics": [
- null
], - "features": {
- "raid": null,
- "txt": null,
- "uefi": null
}
}, - "type": "standard"
}, - "project": {
- "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"
]
}, - "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": [
- null
], - "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": null,
- "wipeTable": null,
- "partitions": [ ]
}
], - "raid": [
- {
- "devices": [ ],
- "level": null,
- "name": null
}
], - "filesystems": [
- {
- "mount": null
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": null,
- "bill_type": null,
- "description": null,
- "id": null,
- "name": null,
- "nni_vlan": null,
- "port": null,
- "project": null,
- "speed": null,
- "status": null,
- "provider_connection_id": null,
- "tags": [ ],
- "type": null,
- "virtual_network": null,
- "vnid": null,
- "created_at": null,
- "updated_at": null
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "project": {
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "state": "active",
- "href": "/bgp-dynamic-neighbors/aea82f16-57ec-412c-9523-b7f2b27635b2",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "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
}
}
Create a VRF BGP Dynamic Neighbor range
Create a VRF BGP Dynamic Neighbor range.
BGP Dynamic Neighbor records are limited to 2 per Virtual Network.
Authorizations:
path Parameters
id required | string <uuid> Metal Gateway UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
bgp_neighbor_range required | string Network range of the dynamic BGP neighbor in CIDR format |
bgp_neighbor_asn required | integer <int64> [ 0 .. 4294967295 ] The ASN of the dynamic BGP neighbor |
tags | Array of strings |
Responses
Response Schema: application/json
id | string <uuid> The unique identifier for the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_neighbor_asn | integer <int64> [ 0 .. 4294967295 ] The ASN of the dynamic BGP neighbor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_neighbor_range | string Network range of the dynamic BGP neighbor in CIDR format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VrfMetalGateway) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "active" "deleting" "pending" "ready" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (UserLimited) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Request samples
- Payload
{- "bgp_neighbor_range": "192.168.1.0/25",
- "bgp_neighbor_asn": 12345,
- "tags": [
- "string"
]
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "id": "aea82f16-57ec-412c-9523-b7f2b27635b2",
- "bgp_neighbor_asn": 12345,
- "bgp_neighbor_range": "192.168.1.0/25",
- "metal_gateway": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- null
], - "type": "vlan",
- "virtual_network": {
- "href": null
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "state": "active",
- "href": "/bgp-dynamic-neighbors/aea82f16-57ec-412c-9523-b7f2b27635b2",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
List Metal Gateway Elastic IPs
Returns the list of Elastic IPs assigned to this Metal Gateway
Authorizations:
path Parameters
id required | string <uuid> Metal Gateway UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (IPAssignment) | |||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 404
{- "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"
}
]
}
Create a Metal Gateway Elastic IP
Create a new Elastic IP on this Metal Gateway.
Assign an IPv4 range as an elastic IP to the Metal Gateway, with a specified next-hop address contained within the Metal Gateway.
Notice: Elastic IPs on Metal Gateways are a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.
Authorizations:
path Parameters
id required | string <uuid> Metal Gateway UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
address required | string An IP address (or IP Address range) contained within one of the project's IP Reservations | ||
next_hop required | string <ipv4> An IP address contained within the Metal Gateways' IP Reservation range. | ||
object Optional User-defined JSON object value. | |||
| |||
tags | Array of strings Optional list of User-defined tags. Can be used by users to provide additional details or context regarding the purpose or usage of this resource. |
Responses
Response Schema: application/json
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. |
Request samples
- Payload
{- "address": "147.75.234.8/31",
- "next_hop": "192.168.12.13",
- "customdata": { },
- "tags": [
- "NY",
- "prod",
- "public"
]
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "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"
}
Returns all metal gateways for a project
Return all metal gateways for a project
Authorizations:
path Parameters
project_id required | string <uuid> Project UUID |
query Parameters
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 |
Responses
Response Schema: application/json
Array of MetalGateway (object) or VrfMetalGateway (object) (MetalGatewayList_metal_gateways_inner) | |||||||||||||||||||||||||||||||||||||
Array Any of
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 404
{- "metal_gateways": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "addon": true,
- "address": "string",
- "address_family": 0,
- "assignments": [
- {
- "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"
}
], - "available": "string",
- "bill": true,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "enabled": true,
- "details": "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"
}, - "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metal_gateway": {
- "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"
}, - "netmask": "string",
- "network": "string",
- "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"
}, - "requested_by": {
- "href": "string"
}, - "public": true,
- "state": "string",
- "tags": [
- "string"
], - "type": "global_ipv4"
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null,
- "longitude": null
}, - "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": null,
- "price": null
}
], - "available_in_metros": [
- {
- "href": null,
- "price": null
}
], - "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": [
- null
], - "memory": {
- "total": null
}, - "drives": [
- null
], - "nics": [
- null
], - "features": {
- "raid": null,
- "txt": null,
- "uefi": null
}
}, - "type": "standard"
}, - "project": {
- "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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": null
}
], - "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": [
- null
]
}
], - "raid": [
- {
- "devices": [
- null
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": null,
- "format": null,
- "point": null,
- "options": [ ]
}
}
]
}, - "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"
}
], - "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"
]
}
}
], - "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}
}
Create a metal gateway
Create a metal gateway in a project
Authorizations:
path Parameters
project_id required | string <uuid> Project UUID |
query Parameters
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 |
Request Body schema: application/jsonrequired
Metal Gateway to create
ip_reservation_id | string <uuid> The UUID of an IP reservation that belongs to the same project as where the metal gateway will be created in. This field is required unless the private IPv4 subnet size is specified. |
private_ipv4_subnet_size | integer The subnet size (8, 16, 32, 64, or 128) of the private IPv4 reservation that will be created for the metal gateway. This field is required unless a project IP reservation was specified. Please keep in mind that the number of private metal gateway ranges are limited per project. If you would like to increase the limit per project, please contact support for assistance. |
virtual_network_id required | string <uuid> The UUID of a metro virtual network that belongs to the same project as where the metal gateway will be created in. |
Responses
Response Schema: application/json
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (IPReservation) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "ready" "active" "deleting" The current state of the Metal Gateway. 'Ready' indicates the gateway record has been configured, but is currently not active on the network. 'Active' indicates the gateway has been configured on the network. 'Deleting' is a temporary state used to indicate that the gateway is in the process of being un-configured from the network, after which the gateway record will be deleted. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Request samples
- Payload
{- "ip_reservation_id": "16a424d8-b135-42c7-baaf-ed317a67e22b",
- "private_ipv4_subnet_size": 0,
- "virtual_network_id": "80f9cbd8-c868-4ff3-8941-d2784e224981"
}
Response samples
- 201
- 401
- 404
- 422
{- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "addon": true,
- "address": "string",
- "address_family": 0,
- "assignments": [
- {
- "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"
}
], - "available": "string",
- "bill": true,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "customdata": { },
- "enabled": true,
- "details": "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"
}, - "gateway": "string",
- "global_ip": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "manageable": true,
- "management": true,
- "metal_gateway": {
- "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"
}, - "netmask": "string",
- "network": "string",
- "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"
}, - "requested_by": {
- "href": "string"
}, - "public": true,
- "state": "string",
- "tags": [
- "string"
], - "type": "global_ipv4"
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}
}
Manage virtual networks (VLANs). See project endpoints to list and create virtual networks. Check out the product docs to learn more about VLANs.
Retrieve all virtual networks
Provides a list of virtual networks for a single project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
metro | string Filter by Metro ID (uuid) or Metro Code |
Responses
Response Schema: application/json
Array of objects (VirtualNetwork) | |||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 401
- 403
- 404
{- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}
]
}
Create a virtual network
Creates an virtual network.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Virtual Network to create
description | string |
metro | string The UUID (or metro code) for the Metro in which to create this Virtual Network. |
vxlan | integer VLAN ID between 2-3999. Must be unique for the project within the Metro in which this Virtual Network is being created. If no value is specified, the next-available VLAN ID in the range 1000-1999 will be automatically selected. |
tags | Array of strings |
Responses
Response Schema: application/json
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assigned_to_virtual_circuit | boolean True if the virtual network is attached to a virtual circuit. False if not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Device) A list of instances with ports currently associated to this Virtual Network. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (MetalGatewayLite) A list of metal gateways currently associated to this Virtual Network. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Metro) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metro_code | string The Metro code of the metro in which this Virtual Network is defined. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vxlan | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Request samples
- Payload
{- "description": "string",
- "metro": "string",
- "vxlan": 1099,
- "tags": [
- "string"
]
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}
Delete a virtual network
Deletes a virtual network.
Authorizations:
path Parameters
id required | string <uuid> Virtual Network UUID |
query Parameters
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. |
Responses
Response samples
- 401
- 403
- 404
- 422
{- "error": "string",
- "errors": [
- "string"
]
}
Get a virtual network
Get a virtual network.
Authorizations:
path Parameters
id required | string <uuid> Virtual Network UUID |
query Parameters
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. |
Responses
Response Schema: application/json
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assigned_to_virtual_circuit | boolean True if the virtual network is attached to a virtual circuit. False if not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Device) A list of instances with ports currently associated to this Virtual Network. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (MetalGatewayLite) A list of metal gateways currently associated to this Virtual Network. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Metro) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metro_code | string The Metro code of the metro in which this Virtual Network is defined. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vxlan | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Response samples
- 200
- 401
- 403
- 404
- 422
{- "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}
Updates the virtual network
Updates the virtual network.
Authorizations:
path Parameters
id required | string <uuid> Virtual Network UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
Virtual network to update
description | string |
tags | Array of strings |
Responses
Response Schema: application/json
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assigned_to_virtual_circuit | boolean True if the virtual network is attached to a virtual circuit. False if not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Device) A list of instances with ports currently associated to this Virtual Network. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (MetalGatewayLite) A list of metal gateways currently associated to this Virtual Network. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Metro) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metro_code | string The Metro code of the metro in which this Virtual Network is defined. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vxlan | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Request samples
- Payload
{- "description": "string",
- "tags": [
- "string"
]
}
Response samples
- 200
- 401
- 403
- 404
- 422
- 429
{- "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}
VRF Management. A VRF is a project-scoped virtual router resource that defines a collection of customer-managed IP blocks that can be used in BGP peering on one or more virtual networks. Metal Gateways and Interconnection Virtual Circuits can take advantage of VRFs to enable Layer 3 routing with custom network ranges.
Delete a VRF BGP Dynamic Neighbor
Trigger the removal of a BGP Neighbor range from a VRF
Authorizations:
path Parameters
id required | string <uuid> BGP Dynamic Neighbor UUID |
query Parameters
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. |
Responses
Response samples
- 202
- 401
- 403
- 404
{- "id": "aea82f16-57ec-412c-9523-b7f2b27635b2",
- "bgp_neighbor_asn": 12345,
- "bgp_neighbor_range": "192.168.1.0/25",
- "metal_gateway": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- null
], - "type": "vlan",
- "virtual_network": {
- "href": null
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "state": "active",
- "href": "/bgp-dynamic-neighbors/aea82f16-57ec-412c-9523-b7f2b27635b2",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
Retrieve a BGP Dynamic Neighbor
Return a single BGP Dynamic Neighbor resource
Authorizations:
path Parameters
id required | string <uuid> BGP Dynamic Neighbor UUID |
query Parameters
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. |
Responses
Response Schema: application/json
id | string <uuid> The unique identifier for the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_neighbor_asn | integer <int64> [ 0 .. 4294967295 ] The ASN of the dynamic BGP neighbor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_neighbor_range | string Network range of the dynamic BGP neighbor in CIDR format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VrfMetalGateway) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "active" "deleting" "pending" "ready" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (UserLimited) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Response samples
- 200
- 401
- 404
{- "id": "aea82f16-57ec-412c-9523-b7f2b27635b2",
- "bgp_neighbor_asn": 12345,
- "bgp_neighbor_range": "192.168.1.0/25",
- "metal_gateway": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- null
], - "type": "vlan",
- "virtual_network": {
- "href": null
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "state": "active",
- "href": "/bgp-dynamic-neighbors/aea82f16-57ec-412c-9523-b7f2b27635b2",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "avatar_thumb_url": "string",
- "avatar_url": "string",
- "full_name": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
Retrieve all VRFs in the project
Returns the list of VRFs for a single project.
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
metro | string Filter by Metro ID (uuid) or Metro Code |
Responses
Response Schema: application/json
object (Meta) | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
Array of objects (Vrf) | |||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 403
- 404
{- "meta": {
- "first": {
- "href": "string"
}, - "last": {
- "href": "string"
}, - "next": {
- "href": "string"
}, - "previous": {
- "href": "string"
}, - "self": {
- "href": "string"
}, - "total": 0,
- "current_page": 0,
- "last_page": 0
}, - "vrfs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
]
}
Create a new VRF in the specified project
Creates a new VRF in the specified project
Authorizations:
path Parameters
id required | string <uuid> Project UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
VRF to create
bgp_dynamic_neighbors_enabled | boolean Toggle to enable the dynamic bgp neighbors feature on the VRF |
bgp_dynamic_neighbors_export_route_map | boolean Toggle to export the VRF route-map to the dynamic bgp neighbors |
bgp_dynamic_neighbors_bfd_enabled | boolean Toggle BFD on dynamic bgp neighbors sessions |
description | string |
ip_ranges | Array of strings A list of CIDR network addresses. Like ["10.0.0.0/16", "2001:d78::/59"]. IPv4 blocks must be between /8 and /29 in size. IPv6 blocks must be between /59 and /64. A VRF's IP ranges must be defined in order to create VRF IP Reservations, which can then be used for Metal Gateways or Virtual Circuits. |
local_asn | integer <int64> [ 0 .. 4294967295 ] |
metro required | string The UUID (or metro code) for the Metro in which to create this VRF. |
name required | string |
tags | Array of strings |
Responses
Response Schema: application/json
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Optional field that can be set to describe the VRF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bill | boolean Default: false True if the VRF is being billed. Usage will start when the first VRF Virtual Circuit is active, and will only stop when the VRF has been deleted. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_dynamic_neighbors_enabled | boolean Toggle to enable the dynamic bgp neighbors feature on the VRF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_dynamic_neighbors_export_route_map | boolean Toggle to export the VRF route-map to the dynamic bgp neighbors | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_dynamic_neighbors_bfd_enabled | boolean Toggle BFD on dynamic bgp neighbors sessions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
local_asn | integer <int64> [ 0 .. 4294967295 ] A 4-byte ASN associated with the VRF. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VrfVirtualCircuit) Virtual circuits that are in the VRF | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ip_ranges | Array of strings A list of CIDR network addresses. Like ["10.0.0.0/16", "2001:d78::/59"]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Metro) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (User) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Request samples
- Payload
{- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "description": "string",
- "ip_ranges": [
- "string"
], - "local_asn": 65000,
- "metro": "string",
- "name": "string",
- "tags": [
- "string"
]
}
Response samples
- 201
- 403
- 404
- 422
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
Delete a VRF Route
Trigger the deletion of a VRF Route resource. The status of the route will update to 'deleting', and the route resource will remain accessible while background operations remove the route from the network. Once the route has been removed from the network, the resource will be fully deleted.
Authorizations:
path Parameters
id required | string <uuid> VRF Route UUID |
query Parameters
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. |
Responses
Response samples
- 202
- 401
- 403
- 404
{- "id": "e1ff9c2b-051a-4688-965f-153e274f77e0",
- "status": "active",
- "prefix": "0.0.0.0/0",
- "next_hop": "192.168.1.254",
- "type": "static",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "metal_gateway": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- null
], - "type": "vlan",
- "virtual_network": {
- "href": null
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "href": "/routes/e1ff9c2b-051a-4688-965f-153e274f77e0",
- "tags": [
- "string"
]
}
Retrieve a VRF Route
Returns a single VRF Route resource
Authorizations:
path Parameters
id required | string <uuid> VRF Route UUID |
query Parameters
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. |
Responses
Response Schema: application/json
id | string <uuid> The unique identifier for the newly-created resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "active" "deleting" "error" The status of the route. Potential values are "pending", "active", "deleting", and "error", representing various lifecycle states of the route and whether or not it has been successfully configured on the network | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
prefix | string The IPv4 prefix for the route, in CIDR-style notation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next_hop | string <ipv4> The next-hop IPv4 address for the route | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "static" VRF route type, like 'bgp', 'connected', and 'static'. Currently, only static routes are supported | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VrfMetalGateway) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Vrf) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Response samples
- 200
- 401
- 404
{- "id": "e1ff9c2b-051a-4688-965f-153e274f77e0",
- "status": "active",
- "prefix": "0.0.0.0/0",
- "next_hop": "192.168.1.254",
- "type": "static",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "metal_gateway": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- null
], - "type": "vlan",
- "virtual_network": {
- "href": null
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "href": "/routes/e1ff9c2b-051a-4688-965f-153e274f77e0",
- "tags": [
- "string"
]
}
Update a VRF Route
Requests a VRF Route be redeployed across the network. Updating the prefix or next-hop address on a route is not currently supported.
Authorizations:
path Parameters
id required | string <uuid> VRF Route UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
prefix | string The IPv4 prefix for the route, in CIDR-style notation. For a static default route, this will always be "0.0.0.0/0" |
next_hop | string <ipv4> The IPv4 address within the VRF of the host that will handle this route |
tags | Array of strings |
Responses
Request samples
- Payload
{- "prefix": "0.0.0.0/0",
- "next_hop": "192.168.1.254",
- "tags": [
- "string"
]
}
Response samples
- 202
- 401
- 403
- 404
- 422
- 429
{- "id": "e1ff9c2b-051a-4688-965f-153e274f77e0",
- "status": "active",
- "prefix": "0.0.0.0/0",
- "next_hop": "192.168.1.254",
- "type": "static",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "metal_gateway": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- null
], - "type": "vlan",
- "virtual_network": {
- "href": null
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "href": "/routes/e1ff9c2b-051a-4688-965f-153e274f77e0",
- "tags": [
- "string"
]
}
Retrieve a VRF
Returns a single VRF resource
Authorizations:
path Parameters
id required | string <uuid> VRF UUID |
query Parameters
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. |
Responses
Response Schema: application/json
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Optional field that can be set to describe the VRF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bill | boolean Default: false True if the VRF is being billed. Usage will start when the first VRF Virtual Circuit is active, and will only stop when the VRF has been deleted. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_dynamic_neighbors_enabled | boolean Toggle to enable the dynamic bgp neighbors feature on the VRF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_dynamic_neighbors_export_route_map | boolean Toggle to export the VRF route-map to the dynamic bgp neighbors | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_dynamic_neighbors_bfd_enabled | boolean Toggle BFD on dynamic bgp neighbors sessions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
local_asn | integer <int64> [ 0 .. 4294967295 ] A 4-byte ASN associated with the VRF. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VrfVirtualCircuit) Virtual circuits that are in the VRF | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ip_ranges | Array of strings A list of CIDR network addresses. Like ["10.0.0.0/16", "2001:d78::/59"]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Metro) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (User) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Response samples
- 200
- 401
- 403
- 404
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
Update the VRF
Updates the VRF.
Authorizations:
path Parameters
id required | string <uuid> VRF UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
VRF to update
bgp_dynamic_neighbors_enabled | boolean Toggle to enable the dynamic bgp neighbors feature on the VRF |
bgp_dynamic_neighbors_export_route_map | boolean Toggle to export the VRF route-map to the dynamic bgp neighbors |
bgp_dynamic_neighbors_bfd_enabled | boolean Toggle BFD on dynamic bgp neighbors sessions |
description | string |
ip_ranges | Array of strings A list of CIDR network addresses. Like ["10.0.0.0/16", "2001:d78::/59"]. IPv4 blocks must be between /8 and /29 in size. IPv6 blocks must be between /59 and /64. A VRF's IP ranges must be defined in order to create VRF IP Reservations, which can then be used for Metal Gateways or Virtual Circuits. Adding a new CIDR address to the list will result in the creation of a new IP Range for this VRF. Removal of an existing CIDR address from the list will result in the deletion of an existing IP Range for this VRF. Deleting an IP Range will result in the deletion of any VRF IP Reservations contained within the IP Range, as well as the VRF IP Reservation's associated Metal Gateways or Virtual Circuits. If you do not wish to add or remove IP Ranges, either include the full existing list of IP Ranges in the update request, or do not specify the |
local_asn | integer <int32> The new |
name | string |
tags | Array of strings |
Responses
Response Schema: application/json
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Optional field that can be set to describe the VRF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bill | boolean Default: false True if the VRF is being billed. Usage will start when the first VRF Virtual Circuit is active, and will only stop when the VRF has been deleted. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_dynamic_neighbors_enabled | boolean Toggle to enable the dynamic bgp neighbors feature on the VRF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_dynamic_neighbors_export_route_map | boolean Toggle to export the VRF route-map to the dynamic bgp neighbors | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bgp_dynamic_neighbors_bfd_enabled | boolean Toggle BFD on dynamic bgp neighbors sessions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
local_asn | integer <int64> [ 0 .. 4294967295 ] A 4-byte ASN associated with the VRF. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VrfVirtualCircuit) Virtual circuits that are in the VRF | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ip_ranges | Array of strings A list of CIDR network addresses. Like ["10.0.0.0/16", "2001:d78::/59"]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Metro) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (User) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Request samples
- Payload
{- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "description": "string",
- "ip_ranges": [
- "string"
], - "local_asn": 0,
- "name": "string",
- "tags": [
- "string"
]
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
Retrieve all VRF IP Reservations in the VRF
Returns the list of VRF IP Reservations for the VRF.
Authorizations:
path Parameters
id required | string <uuid> VRF UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (VrfIpReservation) | |||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 403
- 404
{- "ip_addresses": [
- {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- null
], - "type": "vlan",
- "virtual_network": {
- "href": null
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}
]
}
Retrieve the Specified VRF IP Reservation
Returns the specified IP Reservation for the VRF.
Authorizations:
path Parameters
vrf_id required | string <uuid> VRF UUID |
id required | string <uuid> IP UUID |
query Parameters
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. |
Responses
Response Schema: application/json
address_family | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cidr | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Href) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
details | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <uuid> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (MetalGatewayLite) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
netmask | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type required | string Value: "vrf" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (Vrf) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
management | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manageable | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customdata | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bill | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
address | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gateway | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Metro) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 403
- 404
{- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}
Retrieve all routes in the VRF
Returns the list of routes for the VRF
Authorizations:
path Parameters
id required | string <uuid> VRF UUID |
query Parameters
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. |
Responses
Response Schema: application/json
Array of objects (VrfRoute) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
object (Meta) | |||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 401
- 404
{- "routes": [
- {
- "id": "e1ff9c2b-051a-4688-965f-153e274f77e0",
- "status": "active",
- "prefix": "0.0.0.0/0",
- "next_hop": "192.168.1.254",
- "type": "static",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "metal_gateway": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": null
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- null
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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": 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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null,
- "longitude": null
}, - "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": null,
- "address2": null,
- "city": null,
- "coordinates": null,
- "country": null,
- "state": null,
- "zip_code": null
}, - "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": null,
- "country": null,
- "id": null,
- "name": null
}, - "name": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "need_of_service": true,
- "plan": {
- "available_in": [
- null
], - "available_in_metros": [
- null
], - "categories": [
- null
], - "class": "m3.large.x86",
- "description": "string",
- "deployment_types": [
- null
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legacy": true,
- "line": "string",
- "name": "string",
- "pricing": { },
- "slug": "m3.large.x86",
- "specs": {
- "cpus": [ ],
- "memory": null,
- "drives": [ ],
- "nics": [ ],
- "features": null
}, - "type": "standard"
}, - "project": {
- "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
]
}, - "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": null
}, - "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": null,
- "country": null,
- "id": null,
- "name": null
}, - "netmask": "string",
- "network": "string",
- "parent_block": {
- "cidr": null,
- "href": null,
- "netmask": null,
- "network": null
}, - "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": null,
- "name": null
}, - "data": {
- "mac": null,
- "bonded": null
}, - "disbond_operation_supported": true,
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "bond0",
- "type": "NetworkPort",
- "network_type": "layer2-bonded",
- "native_virtual_network": { },
- "virtual_networks": [
- null
]
}
], - "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": null,
- "price": null
}
], - "available_in_metros": [
- {
- "href": null,
- "price": null
}
], - "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": [
- null
], - "memory": {
- "total": null
}, - "drives": [
- null
], - "nics": [
- null
], - "features": {
- "raid": null,
- "txt": null,
- "uefi": null
}
}, - "type": "standard"
}, - "project": {
- "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"
]
}, - "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": [
- null
], - "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": null,
- "wipeTable": null,
- "partitions": [ ]
}
], - "raid": [
- {
- "devices": [ ],
- "level": null,
- "name": null
}
], - "filesystems": [
- {
- "mount": null
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": null,
- "bill_type": null,
- "description": null,
- "id": null,
- "name": null,
- "nni_vlan": null,
- "port": null,
- "project": null,
- "speed": null,
- "status": null,
- "provider_connection_id": null,
- "tags": [ ],
- "type": null,
- "virtual_network": null,
- "vnid": null,
- "created_at": null,
- "updated_at": null
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "project": {
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "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": [
- {
- "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": null,
- "longitude": null
}, - "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": null,
- "price": null
}
], - "available_in_metros": [
- {
- "href": null,
- "price": null
}
], - "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": [
- null
], - "memory": {
- "total": null
}, - "drives": [
- null
], - "nics": [
- null
], - "features": {
- "raid": null,
- "txt": null,
- "uefi": null
}
}, - "type": "standard"
}, - "project": {
- "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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": null
}
], - "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": [
- null
]
}
], - "raid": [
- {
- "devices": [
- null
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": null,
- "format": null,
- "point": null,
- "options": [ ]
}
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- null
], - "type": "vlan",
- "virtual_network": {
- "href": null
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "href": "/routes/e1ff9c2b-051a-4688-965f-153e274f77e0",
- "tags": [
- "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
}
}
Create a VRF route
Create a route in a VRF. Currently only static default routes are supported.
Authorizations:
path Parameters
id required | string <uuid> VRF UUID |
query Parameters
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. |
Request Body schema: application/jsonrequired
prefix required | string The IPv4 prefix for the route, in CIDR-style notation. For a static default route, this will always be "0.0.0.0/0" |
next_hop required | string <ipv4> The IPv4 address within the VRF of the host that will handle this route |
tags | Array of strings |
Responses
Response Schema: application/json
id | string <uuid> The unique identifier for the newly-created resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "active" "deleting" "error" The status of the route. Potential values are "pending", "active", "deleting", and "error", representing various lifecycle states of the route and whether or not it has been successfully configured on the network | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
prefix | string The IPv4 prefix for the route, in CIDR-style notation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next_hop | string <ipv4> The next-hop IPv4 address for the route | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "static" VRF route type, like 'bgp', 'connected', and 'static'. Currently, only static routes are supported | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VrfMetalGateway) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualNetwork) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Vrf) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings |
Request samples
- Payload
{- "prefix": "0.0.0.0/0",
- "next_hop": "192.168.1.254",
- "tags": [
- "string"
]
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "id": "e1ff9c2b-051a-4688-965f-153e274f77e0",
- "status": "active",
- "prefix": "0.0.0.0/0",
- "next_hop": "192.168.1.254",
- "type": "static",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "metal_gateway": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ip_reservation": {
- "address_family": 0,
- "cidr": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": {
- "href": "string"
}, - "details": "string",
- "href": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "metal_gateway": {
- "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
}, - "netmask": "string",
- "network": "string",
- "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"
]
}, - "state": "string",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "backend_transfer_enabled": null,
- "bgp_config": null,
- "created_at": null,
- "customdata": { },
- "devices": [ ],
- "href": null,
- "id": null,
- "invitations": [ ],
- "max_devices": { },
- "members": [ ],
- "memberships": [ ],
- "name": null,
- "network_status": { },
- "organization": null,
- "payment_method": null,
- "ssh_keys": [ ],
- "updated_at": null,
- "url": null,
- "volumes": [ ],
- "type": null,
- "tags": [ ]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- null
], - "type": "vlan",
- "virtual_network": {
- "href": null
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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": 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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "public": true,
- "management": true,
- "manageable": true,
- "customdata": { },
- "bill": true,
- "project_lite": {
- "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"
]
}, - "address": "string",
- "gateway": "string",
- "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}, - "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"
]
}, - "state": "ready",
- "updated_at": "2019-08-24T14:15:22Z",
- "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": [
- {
- "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": null
}
}
], - "available_in_metros": [
- {
- "href": "string",
- "price": {
- "hour": null
}
}
], - "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": null,
- "type": null
}
], - "memory": {
- "total": "string"
}, - "drives": [
- {
- "count": null,
- "type": null,
- "size": null,
- "category": null
}
], - "nics": [
- {
- "count": null,
- "type": null
}
], - "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": 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"
]
}, - "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": { },
- "virtual_networks": [
- { }
]
}
], - "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": null,
- "number": null,
- "size": null
}
]
}
], - "raid": [
- {
- "devices": [
- "string"
], - "level": "string",
- "name": "string"
}
], - "filesystems": [
- {
- "mount": {
- "device": "string",
- "format": "string",
- "point": "string",
- "options": [
- null
]
}
}
]
}, - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "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": [
- {
- "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": { },
- "virtual_networks": [
- { }
]
}
], - "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"
}
], - "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"
]
}, - "vrf": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "bill": false,
- "bgp_dynamic_neighbors_enabled": true,
- "bgp_dynamic_neighbors_export_route_map": true,
- "bgp_dynamic_neighbors_bfd_enabled": true,
- "local_asn": 65000,
- "virtual_circuits": [
- {
- "customer_ip": "12.0.0.2",
- "customer_ipv6": "2604:1380:4641:a00::6",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "md5": "string",
- "metal_ip": "12.0.0.1",
- "metal_ipv6": "2604:1380:4641:a00::6",
- "name": "string",
- "port": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organization": {
- "href": "string"
}, - "role": "primary",
- "status": "requested",
- "switch_id": "string",
- "virtual_circuits": [
- {
- "bill": false,
- "bill_type": "metal_billed",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "nni_vlan": 0,
- "port": { },
- "project": {
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "provider_connection_id": "dxcon-fggxx63k",
- "tags": [
- "string"
], - "type": "vlan",
- "virtual_network": {
- "href": "string"
}, - "vnid": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "speed": 0,
- "link_status": "string",
- "href": "string"
}, - "nni_vlan": 0,
- "peer_asn": 65000,
- "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"
]
}, - "speed": 0,
- "status": "pending",
- "subnet": "12.0.0.0/30",
- "subnet_ipv6": "2604:1380:4641:a00::4/126",
- "tags": [
- "string"
], - "type": "vrf",
- "vrf": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "ip_ranges": [
- "string"
], - "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"
]
}, - "metro": {
- "code": "string",
- "country": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_by": {
- "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"
}, - "href": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}, - "href": "/routes/e1ff9c2b-051a-4688-965f-153e274f77e0",
- "tags": [
- "string"
]
}
Retrieve learned L3 routes within the VRF
Provides information about learned routes for the VRF. The VRF builds this information dynamically though BGP from other routers in the network.
Authorizations:
path Parameters
id required | string <uuid> VRF UUID |
Responses
Response Schema: application/json
Array of objects (VrfLearnedRoutes) | |||||
Array
|
Response samples
- 200
- 403
- 404
{- "learned_routes": [
- {
- "prefix": "8.8.8.0/24",
- "origin_as": 65000
}
]
}
Retrieve BGP neighbor states for the VRF
Provides BGP peering information such as the IP and state of the neighbor.
Authorizations:
path Parameters
id required | string <uuid> VRF UUID |
Responses
Response Schema: application/json
Array of objects (VrfBGPNeighbors) | |||||||
Array
|
Response samples
- 200
- 403
- 404
{- "bgp_neighbors": [
- {
- "peer_ip": "8.8.8.8",
- "peer_as": 65000,
- "state": "up"
}
]
}