Resources

Cedana API for resources

Get clusters total count

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Total count retrieved successfully

application/json

total_countinteger · int64Required

500

Database error

application/json

get/v2/cluster/count

HTTPcURLJavaScriptPython

GET /v2/cluster/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total_count": 1
}

List jobs

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns jobs

application/json

agestringRequired

completionsinteger · nullableOptional

durationstring · nullableOptional

idstring · uuidRequired

monitored_by_policiesstring[]Required

namestringRequired

namespacestringRequired

pod_idsstring[]Required

policy_countinteger · int64Required

priorityinteger · nullableOptional

start_timestring · nullableOptional

statusstringRequired

500

Failed to fetch from database

application/json

get/v2/jobs

HTTPcURLJavaScriptPython

GET /v2/jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "age": "text",
    "completions": null,
    "duration": null,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "monitored_by_policies": [
      "text"
    ],
    "name": "text",
    "namespace": "text",
    "pod_ids": [
      "text"
    ],
    "policy_count": 1,
    "priority": null,
    "start_time": null,
    "status": "text"
  }
]

Get total count of jobs

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Total count retrieved successfully

application/json

total_countinteger · int64Required

500

Database error

application/json

get/v2/jobs/count

HTTPcURLJavaScriptPython

GET /v2/jobs/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total_count": 1
}

get

Query parameters

priorityinteger · nullableOptional

namespacestring · nullableOptional

statusstring · nullableOptional

Responses

200

List of jobs with applied filters

application/json

available_prioritiesinteger · int32[]Required

total_countinteger · int64Required

500

Internal server error

application/json

get/v2/jobs/filter

HTTPcURLJavaScriptPython

GET /v2/jobs/filter HTTP/1.1
Accept: */*

{
  "available_priorities": [
    1
  ],
  "jobs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "namespace": "text",
      "pod_count": 1,
      "priority": null,
      "start_time": null,
      "status": "text"
    }
  ],
  "total_count": 1
}

Get job namespaces

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Available namespaces retrieved successfully

application/json

namespacesstring[]Required

500

Database error

application/json

get/v2/jobs/namespaces

HTTPcURLJavaScriptPython

GET /v2/jobs/namespaces HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "namespaces": [
    "text"
  ]
}

List jobs (paginated)

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · nullableOptional

offsetinteger · nullableOptional

sortstring · nullableOptional

ascendingboolean · nullableOptional

statusstring · nullableOptional

namespacestring · nullableOptional

job_namestring · nullableOptional

job name to query against (uses postgres ILIKE pattern search)

Responses

200

Returns paginated jobs with total count and available filters

application/json

total_countinteger · int64Required

500

Failed to fetch from database

application/json

get/v2/jobs/paginated

HTTPcURLJavaScriptPython

GET /v2/jobs/paginated HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "available_filters": null,
  "jobs": [
    {
      "age": "text",
      "completions": null,
      "duration": null,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "monitored_by_policies": [
        "text"
      ],
      "name": "text",
      "namespace": "text",
      "pod_ids": [
        "text"
      ],
      "policy_count": 1,
      "priority": null,
      "start_time": null,
      "status": "text"
    }
  ],
  "total_count": 1
}

Get available job priorities with counts

get

Authorizations

api_key

Responses

200

Job priorities retrieved successfully

application/json

prioritiesinteger · int32[]Required

500

Database error

application/json

get/v2/jobs/priorities

HTTPcURLJavaScriptPython

GET /v2/jobs/priorities HTTP/1.1
Accept: */*

{
  "priorities": [
    1
  ],
  "priority_counts": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

get

Path parameters

priorityinteger · int32Required

Priority value to filter jobs by

Responses

200

List of jobs filtered by priority

application/json

total_countinteger · int64Required

500

Internal server error

application/json

get/v2/jobs/priority/{priority}

HTTPcURLJavaScriptPython

GET /v2/jobs/priority/{priority} HTTP/1.1
Accept: */*

{
  "available_filters": null,
  "jobs": [
    {
      "age": "text",
      "completions": null,
      "duration": null,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "monitored_by_policies": [
        "text"
      ],
      "name": "text",
      "namespace": "text",
      "pod_ids": [
        "text"
      ],
      "policy_count": 1,
      "priority": null,
      "start_time": null,
      "status": "text"
    }
  ],
  "total_count": 1
}

Get job statuses

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Available statuses retrieved successfully

application/json

statusesstring[]Required

500

Database error

application/json

get/v2/jobs/statuses

HTTPcURLJavaScriptPython

GET /v2/jobs/statuses HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statuses": [
    "text"
  ]
}

get

Path parameters

job_idstring · uuidRequired

Job ID to get pods for

Responses

200

List of pods managed by the job

application/json

job_idstring · uuidRequired

job_namestringRequired

total_countinteger · int64Required

404

Job not found

application/json

500

Internal server error

application/json

get/v2/jobs/{job_id}/pods

HTTPcURLJavaScriptPython

GET /v2/jobs/{job_id}/pods HTTP/1.1
Accept: */*

{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "job_name": "text",
  "pods": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "namespace": "text",
      "owner_reference": null,
      "status": "text"
    }
  ],
  "total_count": 1
}

List nodes

get

Will only return nodes from clusters with status 'active' if no params are provided. Also, nodes with last_sync older than 5 minutes are not returned.

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idstring · nullableOptional

Responses

200

Returns nodes

application/json

cluster_namestringRequired

compute_typestringRequired

idstring · uuidRequired

instance_typestringRequired

namestringRequired

regionstringRequired

statusstringRequired

500

Failed to fetch from database

application/json

get/v2/nodes

HTTPcURLJavaScriptPython

GET /v2/nodes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "cluster_name": "text",
    "compute_type": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "instance_type": "text",
    "name": "text",
    "region": "text",
    "status": "text"
  }
]

Get nodes total count

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Total count retrieved successfully

application/json

total_countinteger · int64Required

500

Database error

application/json

get/v2/nodes/count

HTTPcURLJavaScriptPython

GET /v2/nodes/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total_count": 1
}

List pods

get

Will not return pods with status 'deleted', and only from clusters with status 'active' and pods belonging to nodes whose last_sync is within the last 5 minutes.

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idstring · nullableOptional

Responses

200

Returns pods

application/json

agestringRequired

idstring · uuidRequired

monitored_by_policiesstring[]Required

namestringRequired

namespacestringRequired

nodestringRequired

readystringRequired

restartsinteger · int32Required

start_timestring · nullableOptional

statusstringRequired

500

Failed to fetch from database

application/json

get/v2/pods

HTTPcURLJavaScriptPython

GET /v2/pods HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "age": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "monitored_by_policies": [
      "text"
    ],
    "name": "text",
    "namespace": "text",
    "node": "text",
    "ready": "text",
    "restarts": 1,
    "start_time": null,
    "status": "text"
  }
]

Get total count of pods

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Total count retrieved successfully

application/json

total_countinteger · int64Required

500

Database error

application/json

get/v2/pods/count

HTTPcURLJavaScriptPython

GET /v2/pods/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total_count": 1
}

List pod namespaces

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns distinct pod namespaces

application/json

namespacesstring[]Required

500

Failed to fetch from database

application/json

get/v2/pods/namespaces

HTTPcURLJavaScriptPython

GET /v2/pods/namespaces HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "namespaces": [
    "text"
  ]
}

List pods (paginated)

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idstring · nullableOptional

limitinteger · nullableOptional

offsetinteger · nullableOptional

sortstring · nullableOptional

ascendingboolean · nullableOptional

statusstring · nullableOptional

namespacestring · nullableOptional

pod_namestring · nullableOptional

pod name to query against (uses postgres ILIKE pattern search)

Responses

200

Returns paginated pods with total count and available filters

application/json

total_countinteger · int64Required

500

Failed to fetch from database

application/json

get/v2/pods/paginated

HTTPcURLJavaScriptPython

GET /v2/pods/paginated HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "available_filters": null,
  "pods": [
    {
      "age": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "monitored_by_policies": [
        "text"
      ],
      "name": "text",
      "namespace": "text",
      "node": "text",
      "ready": "text",
      "restarts": 1,
      "start_time": null,
      "status": "text"
    }
  ],
  "total_count": 1
}

List pod statuses

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns distinct pod statuses

application/json

statusesstring[]Required

500

Failed to fetch from database

application/json

get/v2/pods/statuses

HTTPcURLJavaScriptPython

GET /v2/pods/statuses HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statuses": [
    "text"
  ]
}