Policy

Cedana API for policies

Create policy

post

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cluster_idstringRequired

heartbeat_timeinteger · int64Required

idstring · nullableOptional

policy_typestring · enum · nullableOptionalPossible values:

resourcestring · enum · nullableOptionalPossible values:

resource_idsstring · uuid[]Required

resource_namestringOptional

runc_rootstring · nullableOptional

Responses

200

Policy created successfully

text/plain

stringOptional

400

Invalid request body

application/json

500

Failed to create policy in policy table

application/json

post/v2/policy/create

HTTPcURLJavaScriptPython

POST /v2/policy/create HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "cluster_id": "text",
  "heartbeat_time": 1,
  "id": null,
  "job_filter": null,
  "policy_type": null,
  "resource": null,
  "resource_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "resource_name": "text",
  "runc_root": null
}

text

Delete policy

delete

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstring · uuidRequired

Responses

200

Policy deleted successfully

application/json

Standard error response for API endpoints

codestring · nullableOptional

HTTP status code

detailsanyOptional

Optional additional error details

messagestringRequired

Error message describing what went wrong

400

Invalid request body

application/json

500

Failed to delete policy from policy table

application/json

delete/v2/policy/delete

HTTPcURLJavaScriptPython

DELETE /v2/policy/delete HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "code": null,
  "details": null,
  "message": "text"
}

List policies

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Policies retrieved successfully

application/json

idstringRequired

inputinteger · int64Required

job_countinteger · nullableOptional

pod_countinteger · int64Required

policy_typestringRequired

resourcestringRequired

resource_liststring[]Required

statusstringRequired

timestampstring · nullableOptional

400

Invalid request body

application/json

500

Failed to retriev policies from policy table

application/json

get/v2/policy/list

HTTPcURLJavaScriptPython

GET /v2/policy/list HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "input": 1,
    "job_count": null,
    "pod_count": 1,
    "policy_type": "text",
    "resource": "text",
    "resource_list": [
      "text"
    ],
    "status": "text",
    "timestamp": null
  }
]

Sync job policies manually

post

Authorizations

api_key

Responses

200

Job policies synced successfully

application/json

Standard error response for API endpoints

codestring · nullableOptional

HTTP status code

detailsanyOptional

Optional additional error details

messagestringRequired

Error message describing what went wrong

500

Failed to sync job policies

post/v2/policy/sync-jobs

HTTPcURLJavaScriptPython

POST /v2/policy/sync-jobs HTTP/1.1
Accept: */*

{
  "code": null,
  "details": null,
  "message": "text"
}

Update policy

post

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cluster_idstringRequired

heartbeat_timeinteger · int64Required

idstring · nullableOptional

policy_typestring · enum · nullableOptionalPossible values:

resourcestring · enum · nullableOptionalPossible values:

resource_idsstring · uuid[]Required

resource_namestringOptional

runc_rootstring · nullableOptional

Responses

200

Policy updated successfully

text/plain

stringOptional

400

Invalid request body

application/json

500

Failed to update policy from policy table

application/json

post/v2/policy/update

HTTPcURLJavaScriptPython

POST /v2/policy/update HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "cluster_id": "text",
  "heartbeat_time": 1,
  "id": null,
  "job_filter": null,
  "policy_type": null,
  "resource": null,
  "resource_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "resource_name": "text",
  "runc_root": null
}

text

Get job policy tracking status

get

Authorizations

api_key

Path parameters

policy_idstring · uuidRequired

Policy ID to get status for

Responses

200

Job policy status

application/json

job_idsstring[]Required

job_statusstring · nullableOptional

last_updatedstring · nullableOptional

pod_countinteger · int64Required

policy_idstringRequired

tracked_podsstring[]Required

404

Policy not found

500

Internal server error

get/v2/policy/{policy_id}/job-status

HTTPcURLJavaScriptPython

GET /v2/policy/{policy_id}/job-status HTTP/1.1
Accept: */*

{
  "job_ids": [
    "text"
  ],
  "job_status": null,
  "last_updated": null,
  "pod_count": 1,
  "policy_id": "text",
  "tracked_pods": [
    "text"
  ]
}

Get jobs affected by a policy

get

Authorizations

api_key

Path parameters

policy_idstring · uuidRequired

Policy ID to get affected jobs for

Responses

200

Jobs affected by the policy

application/json

countinteger · int64Required

policy_idstringRequired

404

Policy not found or not a job policy

500

Internal server error

get/v2/policy/{policy_id}/jobs

HTTPcURLJavaScriptPython

GET /v2/policy/{policy_id}/jobs HTTP/1.1
Accept: */*

{
  "affected_jobs": [
    {
      "id": "text",
      "name": "text",
      "namespace": "text",
      "pod_count": 1,
      "priority": null,
      "status": "text"
    }
  ],
  "count": 1,
  "policy_id": "text"
}

Get pods monitored by a specific policy

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policy_idstringRequired

Policy UUID

Responses

200

Returns pods currently monitored by the policy

application/json

idstring · uuidRequired

namestringRequired

namespacestringRequired

statusstringRequired

400

Invalid policy_id format

application/json

404

Policy not found

application/json

500

Failed to connect/fetch from database

application/json

get/v2/policy/{policy_id}/pods

HTTPcURLJavaScriptPython

GET /v2/policy/{policy_id}/pods HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "namespace": "text",
    "status": "text"
  }
]