Cycle Scheduler API (1.0.0)

Download OpenAPI specification:Download

E-mail: support@cycle.io License: Apache-2.0

Functions

Containers configured to be pre-allocated and started on demand - useful for batch processing and tasks with elastic demand. Managed by a scheduler service (this API) on a per-environment basis.

Claim Instance

Reserves an instance of the target function Container. The scheduler will release the claim back into the pool if the Instance is not claimed within ten seconds.

SecurityaccessKey

Request

path Parameters

containerId

required

string

The ID of the requested Container.

Request Body schema: application/json
required

token

required

string

A custom token used for identifying and managing a claim. Can be any valid string, and must be used with spawning and releasing the Instance.

Responses

200

Returns details about the claimed Instance.

default

General error response from the platform

post/v1/functions/{containerId}/claim

Request samples

Payload

application/json

{"token": "string"
}

Response samples

200
default

application/json

{"data": {"instance_id": "651586fca6078e98982dbd90",
"environment": {"id": "651586fca6078e98982dbd90",
"network_subnet": "string",
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"host": 0,
"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"token": "string"
}
}

Spawn Instance

Spawns a previously claimed Instance.

SecurityaccessKey

Request

path Parameters

containerId

required

string

The ID of the requested Container.

Request Body schema: application/json
required

token required	string (ClaimToken) >= 5 characters The claim token previously used to claim the Instance.
instance_id required	string <objectid> (ID) A 24 character hex string used to identify a unique resource.
	object or null Optional variables that affect the runtime of the container.

Responses

200

Returns details about the spawned Instance.

default

General error response from the platform

post/v1/functions/{containerId}/spawn

Request samples

Payload

application/json

{"token": "string",
"instance_id": "651586fca6078e98982dbd90",
"runtime_variables": {"environment_variables": {"property1": "string",
"property2": "string"
}
}
}

Response samples

200
default

application/json

{"data": {"instance_id": "651586fca6078e98982dbd90",
"server_id": "651586fca6078e98982dbd90",
"environment": {"id": "651586fca6078e98982dbd90",
"network_subnet": "string",
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"host": 0,
"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"token": "string"
}
}

Release Instance

Releases a previously spawned Instance.

SecurityaccessKey

Request

path Parameters

containerId

required

string

The ID of the requested Container.

Request Body schema: application/json
required

token required	string (ClaimToken) >= 5 characters The claim token previously used to claim the Instance.
instance_id required	string <objectid> (ID) A 24 character hex string used to identify a unique resource.

Responses

200

Returns details about the released Instance.

default

General error response from the platform

post/v1/functions/{containerId}/release

Request samples

Payload

application/json

{"token": "string",
"instance_id": "651586fca6078e98982dbd90"
}

Response samples

200
default

application/json

{"data": {"instance_id": "651586fca6078e98982dbd90",
"server_id": "651586fca6078e98982dbd90",
"environment": {"id": "651586fca6078e98982dbd90",
"network_subnet": "string",
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"host": 0,
"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"token": "string"
}
}

Get Active Instances

Retrieves instances of the function container that are currently running.

SecurityaccessKey

Request

path Parameters

containerId

required

string

The ID of the requested container.

Responses

200

Returns a map of active instances by ID.

default

General error response from the platform

get/v1/functions/{containerId}/active

Response samples

200
default

application/json

{"data": {"property1": {"id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"container_id": "string",
"location_id": "string",
"environment": {"id": "651586fca6078e98982dbd90",
"network_subnet": "string",
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"host": 0,
"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"function": {"seed": 0
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"purge_time": "2021-01-30T08:30:00Z",
"hostname": "string",
"service": "discovery",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"migration": {"to": {"instance_id": "string",
"server_id": "string"
},
"from": {"instance_id": "string",
"server_id": "string"
},
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z",
"key": "string",
"copy_volumes": true
},
"deployment": {"version": "v1.2.3-dev"
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"container_id": "string",
"location_id": "string",
"environment": {"id": "651586fca6078e98982dbd90",
"network_subnet": "string",
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"host": 0,
"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"function": {"seed": 0
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"purge_time": "2021-01-30T08:30:00Z",
"hostname": "string",
"service": "discovery",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"migration": {"to": {"instance_id": "string",
"server_id": "string"
},
"from": {"instance_id": "string",
"server_id": "string"
},
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z",
"key": "string",
"copy_volumes": true
},
"deployment": {"version": "v1.2.3-dev"
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
}
}

Cycle Scheduler API (1.0.0)

Functions

Claim Instance

path Parameters

Request Body schema: application/jsonrequired

Spawn Instance

path Parameters

Request Body schema: application/jsonrequired

Release Instance

path Parameters

Request Body schema: application/jsonrequired

Get Active Instances

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required