Catalog
Discover cloud regions, zones and available instance types.
Requires pools:read (View grids and servers).
An API key from Account settings, e.g. kn_...
Cloud provider
OK
The request body, query or headers are invalid (invalid_request, invalid_idempotency_key, ...)
The API key is missing, malformed, unknown, revoked or expired
The key lacks a required permission (insufficient_scope), is limited to other projects or to projects while the call acts on the organization (key_project_restricted), the caller's role on the resource is too low (forbidden), or the account is frozen
No such resource, or the caller cannot see it
Too many requests; see the X-RateLimit-* headers and Retry-After
Something failed on our side; the request id is in the body
A service we depend on (the runtime, GitHub) did not answer; retry shortly
The feature is not enabled on this server (github_not_configured), or a service we depend on is down; retry later
A service we depend on did not answer in time; retry shortly
GET /v1/catalog/{csp}/regions HTTP/1.1
Host: api.kinesis.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"regions": [
{
"id": "text",
"name": "text",
"location": "text",
"recommended": true
}
],
"defaultRegion": "text"
}Requires pools:read (View grids and servers).
An API key from Account settings, e.g. kn_...
Cloud provider
Provider region id
OK
The request body, query or headers are invalid (invalid_request, invalid_idempotency_key, ...)
The API key is missing, malformed, unknown, revoked or expired
The key lacks a required permission (insufficient_scope), is limited to other projects or to projects while the call acts on the organization (key_project_restricted), the caller's role on the resource is too low (forbidden), or the account is frozen
No such resource, or the caller cannot see it
Too many requests; see the X-RateLimit-* headers and Retry-After
Something failed on our side; the request id is in the body
A service we depend on (the runtime, GitHub) did not answer; retry shortly
The feature is not enabled on this server (github_not_configured), or a service we depend on is down; retry later
A service we depend on did not answer in time; retry shortly
GET /v1/catalog/{csp}/regions/{region}/zones HTTP/1.1
Host: api.kinesis.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"zones": [
{
"id": "text",
"name": "text"
}
]
}List instance types available in a provider region: the popular picks by default, a search, or everything
Requires pools:read (View grids and servers).
An API key from Account settings, e.g. kn_...
Cloud provider
Provider region id
Limit to one availability zone
Substring to search names and GPU types for
List the full catalog instead of the popular picks
OK
The request body, query or headers are invalid (invalid_request, invalid_idempotency_key, ...)
The API key is missing, malformed, unknown, revoked or expired
The key lacks a required permission (insufficient_scope), is limited to other projects or to projects while the call acts on the organization (key_project_restricted), the caller's role on the resource is too low (forbidden), or the account is frozen
No such resource, or the caller cannot see it
Too many requests; see the X-RateLimit-* headers and Retry-After
Something failed on our side; the request id is in the body
A service we depend on (the runtime, GitHub) did not answer; retry shortly
The feature is not enabled on this server (github_not_configured), or a service we depend on is down; retry later
A service we depend on did not answer in time; retry shortly
GET /v1/catalog/{csp}/regions/{region}/instance-types HTTP/1.1
Host: api.kinesis.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"instanceTypes": [
{
"id": "text",
"name": "text",
"category": "text",
"specs": {
"vCpus": 1,
"memory": "text",
"storage": "text",
"networkPerformance": "text",
"gpuType": "text",
"gpuManufacturer": "text",
"gpuCount": 1,
"gpuMemory": "text"
},
"pricePerHour": 1,
"inStock": null
}
]
}Was this helpful?