Deployments

List deployments with pagination and filtering

Changed on
get/v1/deployments

Request

  • Base URL
    https://console-api-sandbox.akash.network
  • URL
    https://console-api-sandbox.akash.network/v1/deployments
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Query parameters

state'active' | 'closed'

Which of the owner's deployments to list. closed serves the archive.

reverse'true' | 'false'

Newest deployment first when true, rather than the default oldest-first order.

searchstring

Case-insensitive substring matched against each deployment's console name and its dseq. It spans every deployment in state before paging, so total and hasMore describe the matches rather than the state. A search of active deployments is refused past a cap on how many it spans; a search of the archive (closed) has no cap while the console's index answers.

skipinteger nullable

Deployments to skip before the page begins.

limitinteger

Deployments per page, at most 100. Omitting it pages from the start rather than returning every deployment, so page on while hasMore is true.

projectIdstring uuid

Lists only the deployments filed in this project. A project the caller cannot reach lists nothing, like one that does not exist. Ignored outside organization mode.

Headers

x-organization-idstring

Id or slug of the organization the request runs in. Defaults to the organization used last, or the caller's personal one. Answers 403 organization_forbidden when the caller is not a member, and 400 organization_mismatch when it names another organization than the API key's.

x-project-idstring uuid

Id of a project of the active organization to limit the request to. Answers 403 project_forbidden when the caller cannot reach the project, or the API key is limited to another one.

Response

Returns paginated list of deployments

Changes

    • warning

      for the query request parameter skip, the max was set to 9007199254740991.00

    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new optional header request parameter x-project-id

    • info

      added the new optional query request parameter projectId

    • info

      added the optional property /// to the response with the status