List addons | Addons | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Addons /

List addons

Gets a list of addons belonging to the project

Required permission

Project > Addons > General > Read

Path parameters

    • projectId

      string required

      ID of the project

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.

      • addons

        [array] required

        An array of addons.

        • {object}

          Information about an addon.

          • id

            string required

            Identifier for the addon.

          • name

            string required

            Addon name.

          • appId

            string required

            Full identifier for the addon.

          • tags

            [array] required

            An array of previously defined tags to help identify and group the resource.

            • string
              min length
              3
              max length
              39
              pattern
              ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

          • description

            string

            A short description of the addon.

          • spec

            {object} required

            Details about the addon's specifications.

          • status

            string required

            The current state of the addon.

            one of
            preDeployment, triggerAllocation, allocating, postDeployment, running, paused, scaling, upgrading, resetting, backup, restore, failed, deleting, deleted

    • 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

Example response

200 OK

A list of addons belonging to the project.

JSON

{
  "data": {
    "addons": [
      {
        "id": "example-addon",
        "name": "Example Addon",
        "appId": "/example-user/default-project/example-job",
        "tags": [
          "my-tag"
        ],
        "description": "This is the addon description",
        "spec": {
          "type": "mongodb"
        },
        "status": "running"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com