Routes | API Reference | Turing-APAC Docs

List Routes

get

List all service routes.

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

422

Validation Error

application/json

get

/v1/admin/routes

GET /v1/admin/routes HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "service_name": "text",
    "url": "text",
    "description": "text",
    "quota_limit": 1,
    "quota_unit": "text",
    "health_endpoint": "text",
    "docs_endpoint": "text",
    "redoc_endpoint": "text",
    "openapi_endpoint": "text",
    "api_path": "text",
    "path_transformation": "text",
    "service_headers": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "enabled": true,
    "created_at": "text",
    "updated_at": "text"
  }
]

Create Route

post

Create a new service route.

Requires: super_admin role

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

Request to create a new service route.

service_namestringRequired

urlstringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

quota_limitintegerOptionalDefault: 500

quota_unitstringOptionalDefault: requests/min

health_endpointstringOptionalDefault: /api/v1/health

docs_endpointstringOptionalDefault: /api/v1/docs

redoc_endpointstringOptionalDefault: /api/v1/redoc

openapi_endpointstringOptionalDefault: /api/v1/openapi.json

api_pathstringOptionalDefault: /api/v1

path_transformationstringOptionalDefault: strip_prefix

service_headersany ofOptional

or

nullOptional

enabledbooleanOptionalDefault: true

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/admin/routes

POST /v1/admin/routes HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 374

{
  "service_name": "text",
  "url": "text",
  "description": "text",
  "quota_limit": 500,
  "quota_unit": "requests/min",
  "health_endpoint": "/api/v1/health",
  "docs_endpoint": "/api/v1/docs",
  "redoc_endpoint": "/api/v1/redoc",
  "openapi_endpoint": "/api/v1/openapi.json",
  "api_path": "/api/v1",
  "path_transformation": "strip_prefix",
  "service_headers": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true
}

{
  "id": "text",
  "service_name": "text",
  "url": "text",
  "description": "text",
  "quota_limit": 1,
  "quota_unit": "text",
  "health_endpoint": "text",
  "docs_endpoint": "text",
  "redoc_endpoint": "text",
  "openapi_endpoint": "text",
  "api_path": "text",
  "path_transformation": "text",
  "service_headers": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Get Route

get

Get route details by ID.

Requires: super_admin or org_admin role

Path parameters

route_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/admin/routes/{route_id}

GET /v1/admin/routes/{route_id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "service_name": "text",
  "url": "text",
  "description": "text",
  "quota_limit": 1,
  "quota_unit": "text",
  "health_endpoint": "text",
  "docs_endpoint": "text",
  "redoc_endpoint": "text",
  "openapi_endpoint": "text",
  "api_path": "text",
  "path_transformation": "text",
  "service_headers": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Delete Route

delete

Delete a service route.

Requires: super_admin role

Path parameters

route_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/routes/{route_id}

DELETE /v1/admin/routes/{route_id} HTTP/1.1
Host: 
Accept: */*

No content

Update Route

patch

Update a service route.

Requires: super_admin role

Path parameters

route_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

Request to update a service route.

urlany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

quota_limitany ofOptional

integerOptional

or

nullOptional

quota_unitany ofOptional

stringOptional

or

nullOptional

health_endpointany ofOptional

stringOptional

or

nullOptional

docs_endpointany ofOptional

stringOptional

or

nullOptional

redoc_endpointany ofOptional

stringOptional

or

nullOptional

openapi_endpointany ofOptional

stringOptional

or

nullOptional

api_pathany ofOptional

stringOptional

or

nullOptional

path_transformationany ofOptional

stringOptional

or

nullOptional

service_headersany ofOptional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

patch

/v1/admin/routes/{route_id}

PATCH /v1/admin/routes/{route_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 288

{
  "url": "text",
  "description": "text",
  "quota_limit": 1,
  "quota_unit": "text",
  "health_endpoint": "text",
  "docs_endpoint": "text",
  "redoc_endpoint": "text",
  "openapi_endpoint": "text",
  "api_path": "text",
  "path_transformation": "text",
  "service_headers": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true
}

{
  "id": "text",
  "service_name": "text",
  "url": "text",
  "description": "text",
  "quota_limit": 1,
  "quota_unit": "text",
  "health_endpoint": "text",
  "docs_endpoint": "text",
  "redoc_endpoint": "text",
  "openapi_endpoint": "text",
  "api_path": "text",
  "path_transformation": "text",
  "service_headers": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Toggle Route

post

Enable or disable a service route.

Requires: super_admin role

Path parameters

route_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

422

Validation Error

application/json

post

/v1/admin/routes/{route_id}/toggle

POST /v1/admin/routes/{route_id}/toggle?enabled=true HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "service_name": "text",
  "url": "text",
  "description": "text",
  "quota_limit": 1,
  "quota_unit": "text",
  "health_endpoint": "text",
  "docs_endpoint": "text",
  "redoc_endpoint": "text",
  "openapi_endpoint": "text",
  "api_path": "text",
  "path_transformation": "text",
  "service_headers": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Good night

List Routes

Create Route

Get Route

Delete Route

Update Route

Toggle Route