Policies

List Policies

get

List all service policies.

Requires: super_admin or org_admin role

Query parameters

enabled_onlybooleanOptionalDefault: false

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for service policy.

idstringRequired

service_namestringRequired

policy_typestringRequired

enabledbooleanRequired

created_atstringRequired

updated_atany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/admin/policies

HTTPcURLJavaScriptPython

GET /v1/admin/policies HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "service_name": "text",
    "policy_type": "text",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "enabled": true,
    "created_at": "text",
    "updated_at": "text"
  }
]

Create Policy

post

Create a new service policy.

Requires: super_admin role

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

application/json

Request to create a new service policy.

service_namestringRequired

policy_typestringRequired

enabledbooleanOptionalDefault: true

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/admin/policies

HTTPcURLJavaScriptPython

POST /v1/admin/policies HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "service_name": "text",
  "policy_type": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true
}

{
  "id": "text",
  "service_name": "text",
  "policy_type": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Get Policy

get

Get policy details by ID.

Requires: super_admin or org_admin role

Path parameters

policy_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for service policy.

idstringRequired

service_namestringRequired

policy_typestringRequired

enabledbooleanRequired

created_atstringRequired

updated_atany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/admin/policies/{policy_id}

HTTPcURLJavaScriptPython

GET /v1/admin/policies/{policy_id} HTTP/1.1
Accept: */*

{
  "id": "text",
  "service_name": "text",
  "policy_type": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Update Policy Put

put

Update a service policy (PUT).

Requires: super_admin role

Path parameters

policy_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

application/json

Request to update a service policy.

configany ofOptional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for service policy.

idstringRequired

service_namestringRequired

policy_typestringRequired

enabledbooleanRequired

created_atstringRequired

updated_atany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

put

/v1/admin/policies/{policy_id}

HTTPcURLJavaScriptPython

PUT /v1/admin/policies/{policy_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true
}

{
  "id": "text",
  "service_name": "text",
  "policy_type": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Delete Policy

delete

Delete a service policy.

Requires: super_admin role

Path parameters

policy_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/admin/policies/{policy_id}

HTTPcURLJavaScriptPython

DELETE /v1/admin/policies/{policy_id} HTTP/1.1
Accept: */*

No content

Update Policy Patch

patch

Update a service policy (PATCH).

Requires: super_admin role

Path parameters

policy_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

application/json

Request to update a service policy.

configany ofOptional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for service policy.

idstringRequired

service_namestringRequired

policy_typestringRequired

enabledbooleanRequired

created_atstringRequired

updated_atany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

patch

/v1/admin/policies/{policy_id}

HTTPcURLJavaScriptPython

PATCH /v1/admin/policies/{policy_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true
}

{
  "id": "text",
  "service_name": "text",
  "policy_type": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Toggle Policy

post

Enable or disable a service policy.

Requires: super_admin role

Path parameters

policy_idstringRequired

Query parameters

enabledbooleanRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for service policy.

idstringRequired

service_namestringRequired

policy_typestringRequired

enabledbooleanRequired

created_atstringRequired

updated_atany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

post

/v1/admin/policies/{policy_id}/toggle

HTTPcURLJavaScriptPython

POST /v1/admin/policies/{policy_id}/toggle?enabled=true HTTP/1.1
Accept: */*

{
  "id": "text",
  "service_name": "text",
  "policy_type": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}