logo

Servers

Endpoints related to managing servers on Cycle.

List Servers

Requires the servers-view capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Enum: "node" "instances_count"
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "locations" "models" "integrations" "clusters"
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of Servers.

default

General error response from the platform

get/v1/infrastructure/servers
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Create Server

Requires the servers-provision capability.

SecuritybearerAuth and hubAuth
Request
Request Body schema: application/json

Parameters for creating a Server.

cluster
required
string

The existing or new cluster this infrastructure should be provisioned in.

required
Array of objects

An array of servers to provision.

Responses
202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/infrastructure/servers
Request samples
application/json
{
  • "cluster": "string",
  • "servers": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}

Get Server

Requires the servers-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
serverId
required
string

The ID for the given Server.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "locations" "models" "integrations" "clusters"
meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Enum: "node" "instances_count" "allocations"
Responses
200

Returns a Server.

default

General error response from the platform

get/v1/infrastructure/servers/{serverId}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Update Server

Requires the servers-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
serverId
required
string

The ID for the given Server.

Request Body schema: application/json

Parameters for updating a Server.

required
object

Server constriants.

Responses
200

Returns a Server.

default

General error response from the platform

patch/v1/infrastructure/servers/{serverId}
Request samples
application/json
{
  • "constraints": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Delete Server

Requires the servers-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
serverId
required
string

The ID of the Server.

query Parameters
object

The option field is a key-value object, where the key is the option, and the value is a boolean. For example, ?option[force]=true

Responses
200

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/infrastructure/servers/{serverId}
Response samples
application/json
{
  • "data": {
    }
}

Get Server Telemetry

This call requires the filter query parameter to be used.

Requires the servers-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
serverId
required
string

The ID for the given Server.

query Parameters
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of telemetry points.

default

General error response from the platform

get/v1/infrastructure/servers/{serverId}/telemetry
Response samples
application/json
{
  • "data": [
    ]
}

List Server Instances

Requires the containers-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
serverId
required
string

The ID for the given server.

query Parameters
object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "creator" "servers" "locations" "integrations" "containers" "environments"
Responses
200

Returns a list of Instances present on this Server.

default

General error response from the platform

get/v1/infrastructure/servers/{serverId}/instances
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Create Server Job

Used to perform different actions on a given Server. Requires the servers-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
serverId
required
string

The ID for the given Server.

Request Body schema: application/json

Parameters for creating the new Server Job.

action
required
string

The action to take.

required
object
Responses
202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/infrastructure/servers/{serverId}/tasks
Request samples
application/json
{
  • "action": "sharedfs.reconfigure",
  • "contents": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

List Server Tags

Requires the servers-view capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

Responses
200

Returns a list of Server Tags.

default

General error response from the platform

get/v1/infrastructure/servers/tags
Response samples
application/json
{
  • "data": [
    ]
}

Get Server Usage

Requires the servers-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
serverId
required
string

The ID for the given server.

Responses
200

Returns usage data for the Server.

default

General error response from the platform

get/v1/infrastructure/servers/{serverId}/usage
Response samples
application/json
{
  • "data": {
    }
}

Get Server Console

Gets the authorization information required to connect to a Server console websocket.

Requires the servers-console capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
serverId
required
string

The ID of the server to connect to.

Responses
200

Returns console credentials for the Server.

default

General error response from the platform

get/v1/infrastructure/servers/{serverId}/console
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to IPs