Edit

PATCH
/workspaces
/:domain
/integrations
/:hash_id

Edits the integration with the specified ID.

Request

REQUIRED SCOPES

INTEGRATION_MANAGE

URL PARAMETERS

domainrequired string

The workspace domain.

hash_idrequired string

The hash_id of the integration.

POST PARAMETERS

namerequired string

The name of the integration.

typerequired string

The type of the integration (listed above).

scoperequired string

The scope of the integration. Can be WORKSPACE or PROJECT.

project_nameoptional integer

The name of the project. Required if scope is set to PROJECT.

usernameoptional string

The username for UPCLOUD, RACKSPACE or DOCKER_HUB integration.

shopoptional string

The name of the shop for SHOPIFY integration.

tokenoptional string

The token for integrations: DIGITAL_OCEAN, SHOPIFY, RACKSPACE, CLOUDFLARE, NEW_RELIC, SENTRY, ROLLBAR, DATADOG, HONEYBADGER, VULTR, SENTRY_ENTERPRISE, LOGGLY, FIREBASE, GHOST_INSPECTOR

access_keyoptional string

The access key for integrations DO_SPACES and AMAZON.

secret_keyoptional string

The secret key for integrations DO_SPACES and AMAZON.

app_idoptional string

The application ID for AZURE_CLOUD integration.

tenant_idoptional string

The tenant ID for AZURE_CLOUD integration.

passwordoptional string

The password for AZURE_CLOUD, UPCLOUD and DOCKER_HUB integrations.

api_keyoptional string

The API key from the account for CLOUDFLARE integration. The alternative option to add it besides using the token.

role_assumptionsoptional string

The list of role assumptions for AMAZON integration.

emailoptional string

Email for CLOUDFLARE integration. Required if api_key is sent.

permissionsoptional permissions

Define to set permissions for the integration.

all_pipelines_allowedoptional Boolean

Defines whether all pipelines are allowed to use the integration.

allowed_pipelinesoptional Pipeline[]

Defines an object with the property id for pipelines that can use this integration.

Last modified on Sep 25, 2024

List Delete

Example:

curl -X PATCH "https://api.buddy.works/workspaces/:domain/integrations/:hash_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Buddy AWS integration",
  "type": "AMAZON",
  "scope": "PROJECT",
  "project_name": "company-website",
  "access_key": "AKIAVASPKE3ZWWV7V5BI",
  "secret_key": "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",
  "identifier": "my_aws_integration",
  "role_assumptions": [
    {
      "arn": "arn:aws:iam::123457465779:role/TESTS",
      "external_id": "ext_id",
      "duration": 9000
    }
  ],
  "all_pipelines_allowed": false,
  "permissions": {
    "admins": "MANAGE",
    "others": "DENIED",
    "users": [
      {
        "id": 1,
        "access_level": "USE_ONLY"
      }
    ],
    "groups": [
      {
        "id": 1,
        "access_level": "USE_ONLY"
      }
    ]
  },
  "allowed_pipelines": [
    {
      "id": 1
    }
  ]
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/integrations/5fff3231277e1449d8eb3e6a",
  "html_url": "https://app.buddy.works/buddy/workspace/integrations",
  "hash_id": "5fff3231277e1449d8eb3e6a",
  "name": "Buddy AWS integration",
  "type": "AMAZON",
  "scope": "PROJECT",
  "identifier": "my_aws_integration",
  "project_name": "company-website",
  "all_pipelines_allowed": false,
  "permissions": {
    "admins": "MANAGE",
    "others": "DENIED",
    "users": [
      {
        "id": 1,
        "access_level": "USE_ONLY"
      }
    ],
    "groups": [
      {
        "id": 1,
        "access_level": "USE_ONLY"
      }
    ]
  },
  "allowed_pipelines": [
    {
      "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1",
      "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1",
      "id": 1,
      "name": "Tests"
    }
  ]
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999