Policy

Cedana API for policies

Create policy

post

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cluster_idstringRequired

heartbeat_timeinteger · int64Required

idstring | nullOptional

policy_typeone ofOptional

nullOptional

or

string · enumOptionalPossible values:

resourceone ofOptional

nullOptional

or

string · enumOptionalPossible values:

resource_idsstring · uuid[]Required

resource_namestringOptional

Responses

200

Policy created successfully

text/plain

Responsestring

400

Invalid request body

text/plain

500

Failed to create policy in policy table

text/plain

post

/v2/policy/create

HTTPcURLJavaScriptPython

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

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

text

Delete policy

delete

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstring · uuidRequired

Responses

200

Policy deleted successfully

text/plain

Responsestring

400

Invalid request body

text/plain

500

Failed to delete policy from policy table

text/plain

delete

/v2/policy/delete

HTTPcURLJavaScriptPython

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

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

text

List policies

get

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Policies retrieved successfully

application/json

400

Invalid request body

text/plain

500

Failed to retriev policies from policy table

text/plain

get

/v2/policy/list

HTTPcURLJavaScriptPython

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

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

Update policy

post

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cluster_idstringRequired

heartbeat_timeinteger · int64Required

idstring | nullOptional

policy_typeone ofOptional

nullOptional

or

string · enumOptionalPossible values:

resourceone ofOptional

nullOptional

or

string · enumOptionalPossible values:

resource_idsstring · uuid[]Required

resource_namestringOptional

Responses

200

Policy updated successfully

text/plain

Responsestring

400

Invalid request body

text/plain

500

Failed to update policy from policy table

text/plain

post

/v2/policy/update

HTTPcURLJavaScriptPython

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

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

text

Get pods monitored by a specific policy

get

Authorizations

Auth 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

400

Invalid policy_id format

text/plain

404

Policy not found

text/plain

500

Failed to connect/fetch from database

text/plain

get

/v2/policy/{policy_id}/pods

HTTPcURLJavaScriptPython

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

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