v1
Double column
API
CLI
JS Client

Addons /

List addon containers

Gets a list of containers for the given addon.

Required permission

Project > Addons > Deployment > View Instances

Path parameters

    • projectId

      string required

      ID of the project

    • addonId

      string required

      ID of the addon

Query parameters

    • per_page

      integer

      The number of results to display per request. Maximum of 100 results per page.

    • page

      integer

      The page number to access.

    • cursor

      string

      The cursor returned from the previous page of results, used to request the next page.

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • pods

        [array] required

        An array of containers.

        • {object}

          Data about a container.

          • createdAt

            integer required

            The timestamp the pod was created.

            min
            1
          • podName

            string required

            The name of the pod.

          • region

            string required

            The region where the pod is deployed.

          • status

            string required

            The current status of the pod.

            one of
            TASK_RUNNING, TASK_STARTING, TASK_STAGING, TASK_KILLING, TASK_KILLED, TASK_FAILED, TASK_FINISHED
    • pagination

      {object} required

      Data about the endpoint pagination.

      • hasNextPage

        boolean required

        Is there another page of results available?

      • cursor

        string

        The cursor to access the next page of results.

      • count

        number required

        The number of results returned by this request.

API
CLI
JS Client

GET /v1/projects/{projectId}/addons/{addonId}/containers

Example response

200 OK

Details about the addon's containers.

JSON

{
  "data": {
    "pods": [
      {
        "createdAt": 1611241087,
        "podName": "example-service-78b4d4459d-sbtn8",
        "region": "europe-west",
        "status": "TASK_RUNNING"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2022 Northflank Ltd. All rights reserved.