Project / External Addons /

List external addons

Gets a list of external addons belonging to the project

Required permission

Project > ExternalAddons > 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.
resourceType
string
Filter by resource type (s3, rds)
status
string
Filter by status (creating, active, error, deleting, deleted)

Response body

{object}
Response object.

data
{object} required
Result data.

data
{object} required

externalAddons
[array] required
List of external addons

{object}
External addon object

description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
tags
[array]
An array of previously defined tags to help identify and group the resource.

string
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

environmentId
string
spec
{object}
name
string required
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$

pagination
{object} required
Pagination information

page
integer required
Current page number
perPage
integer required
Items per page
total
integer required
Total number of items

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}/external-addons

GET /v1/teams/{teamId}/projects/{projectId}/external-addons

Example response

200 OK

A list of external addons belonging to the project.

JSON

{
  "data": {
    "data": {
      "externalAddons": [
        {
          "spec": {
            "provider": {
              "aws": {
                "region": "eu-west-1"
              },
              "google": {
                "region": "us-central1",
                "zone": "us-central1-c"
              }
            }
          }
        }
      ]
    }
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}