Skip to main content
GET
/
deployments
/
list-deployments
List Deployments
curl --request GET \
  --url https://api.enkryptai.com/deployments/list-deployments \
  --header 'apikey: <api-key>'
{
  "deployments": [
    {
      "deployment_id": "1234567890",
      "name": "test-deployment",
      "model_saved_name": "Test Model",
      "model_version": "v1",
      "created_at": "2025-02-21T09:28:52.651201+00:00",
      "updated_at": "2025-02-21T09:28:52.651201+00:00",
      "project_name": "default"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total_count": 25,
    "total_pages": 3,
    "has_next": true,
    "has_previous": false
  }
}

​
List Deployments

Retrieve a paginated list of all deployments in your account.

​
Query Parameters

ParameterTypeRequiredDefaultDescription
statusstringNo-Filter deployments by status
pageintegerNo1Page number (must be >= 1)
per_pageintegerNo10Number of items per page (must be between 1 and 100)

​
Headers

HeaderTypeRequiredDescription
X-Enkrypt-Refresh-CachebooleanNoRefresh the cache if data is stale

​
Example Request

curl -X GET "https://api.enkryptai.com/deployments/list-deployments?page=1&per_page=10" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Enkrypt-Refresh-Cache: false"

​
Example Response

{
  "deployments": [
    {
      "deployment_id": "1234567890",
      "name": "test-deployment",
      "model_saved_name": "Test Model",
      "model_version": "v1",
      "created_at": "2025-02-21T09:28:52.651201+00:00",
      "updated_at": "2025-02-21T09:28:52.651201+00:00",
      "project_name": "default"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total_count": 25,
    "total_pages": 3,
    "has_next": true,
    "has_previous": false
  }
}

​
Error Responses

​
400 Bad Request - Invalid Pagination Parameters

{
  "error": "Invalid pagination parameters. Page must be >= 1, per_page must be between 1 and 100"
}

​
Pagination

The response includes pagination metadata to help you navigate through the results:
  • page: Current page number
  • per_page: Number of items per page
  • total_count: Total number of items across all pages
  • total_pages: Total number of pages
  • has_next: Boolean indicating if there’s a next page
  • has_previous: Boolean indicating if there’s a previous page
To get the next page, increment the page parameter. For example, to get page 2: 
GET /deployments/list-deployments?page=2&per_page=10

Authorizations

​
apikey
string
header
required

Headers

​
X-Enkrypt-Refresh-Cache
boolean

Refresh the cache if data is stale

Example:

false

Query Parameters

​
status
string

Filter deployments by status

​
page
integer
default:1

Page number (must be >= 1)

Required range: x >= 1
Example:

1

​
per_page
integer
default:10

Number of items per page (must be between 1 and 100)

Required range: 1 <= x <= 100
Example:

10

Response

Successful Response

​
deployments
deployment · object[]
​
pagination
object
⌘I