Project / External Addons /

Get external addon

Gets information about the given external addon

Required permission

Project > ExternalAddons > General > Read

Path parameters

projectId
string required
ID of the project
externalAddonId
string required
ID of the external addon

Response body

{object}
Response object.

data
{object} required
Result data.

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]+)*$

API

CLI

JS Client

GET /v1/projects/{projectId}/external-addons/{externalAddonId}

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

Example response

200 OK

Details about the external addon.

JSON

{
  "data": {
    "spec": {
      "provider": {
        "aws": {
          "region": "eu-west-1"
        },
        "google": {
          "region": "us-central1",
          "zone": "us-central1-c"
        }
      }
    }
  }
}