Edit an integration

Edits the integration.

Required scopes: INTEGRATION_MANAGE

Resource URL

PATCH /workspaces/:domain/integrations/:hash_id

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
hash_id
Required
StringThe hash_id of the integration that you want to edit.

POST Parameters

NameTypeDescription
name
Required
StringThe name of the integration.
type
Required
StringThe type of the integration (listed above).
scope
Required
StringThe scope of the integration. Can be one of: PRIVATE, WORKSPACE, ADMIN, GROUP or PROJECT.
project_idIntegerThe ID of the project. Required if scope is set to PROJECT.
group_idIntegerThe ID of the group. Required if scope is set to GROUP.
usernameStringThe username for UPCLOUD integration.
shopStringThe name of the shop for SHOPIFY integration.
tokenStringThe token for integrations: DIGITAL_OCEAN, SHOPIFY, RACKSPACE, CLOUDFLARE, NEW_RELIC, SENTRY, ROLLBAR, DATADOG, HONEYBADGER, VULTR, SENTRY_ENTERPRISE, LOGGLY, FIREBASE, GHOST_INSPECTOR
access_keyStringThe access key for integrations DO_SPACES and AMAZON.
secret_keyStringThe secret key for integrations DO_SPACES and AMAZON.
app_idStringThe application ID for AZURE_CLOUD integration.
tenant_idStringThe tenant ID for AZURE_CLOUD integration.
passwordStringThe password for AZURE_CLOUD and UPCLOUD integrations.
api_keyStringThe API key from the account for CLOUDFLARE integration. The alternative option to add it besides using the token.
role_assumptionsStringThe list of role assumptions for AMAZON integration.

Role assumptions

NameTypeDescription
arn
Required
StringRole arn to assume.
external_id
Required
StringThe external ID for the role.
durationIntegerMaximum session duration setting for the role. Can have values between 900 and 43200.

Example

Request

PATCH https://api.buddy.works/workspaces/buddy/integrations/5fff3231277e1449d8eb3e6a

JSON

{
"name":"Buddy AWS integration",
"type":"AMAZON",
"scope":"PROJECT",
"project_id": 1,
"access_key":"AKIAVASPKE3ZWWV7V5BI",
"secret_key":"Pd7TefPBRjF3CfevJaXdyYMZmiC9V+aSnYLvY+GC",
"role_assumptions":[
{
"arn":"arn:aws:iam::123457465779:role/TESTS",
"external_id":"ext_id",
"duration":9000
}
]
}

Sample 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",
"project_id": 1
}