Edit an integration
Edits the integration.
Required scopes: INTEGRATION_MANAGE
Resource URL
PATCH /workspaces/:domain/integrations/:hash_id
URL Parameters
| Name | Type | Description |
|---|---|---|
domain Required | String | The workspace domain. |
hash_id Required | String | The hash_id of the integration that you want to edit. |
POST Parameters
| Name | Type | Description | |
|---|---|---|---|
name Required | String | The name of the integration. | |
type Required | String | The type of the integration (listed above). | |
scope Required | String | The scope of the integration. Can be one of: PRIVATE, WORKSPACE, ADMIN, GROUP, PROJECT, ADMIN_IN_PROJECT or GROUP_IN_PROJECT. | |
| project_id | Integer | The ID of the project. Required if scope is set to PROJECT, ADMIN_IN_PROJECT or GROUP_IN_PROJECT. | |
| group_id | Integer | The ID of the group. Required if scope is set to GROUP or GROUP_IN_PROJECT. | |
| username | String | The username for UPCLOUD, RACKSPACE or DOCKER_HUB integration. | |
| shop | String | The name of the shop for SHOPIFY integration. | |
| token | String | The token for integrations: DIGITAL_OCEAN, SHOPIFY, RACKSPACE, CLOUDFLARE, NEW_RELIC, SENTRY, ROLLBAR, DATADOG, HONEYBADGER, VULTR, SENTRY_ENTERPRISE, LOGGLY, FIREBASE, GHOST_INSPECTOR | |
| access_key | String | The access key for integrations DO_SPACES and AMAZON. | |
| secret_key | String | The secret key for integrations DO_SPACES and AMAZON. | |
| app_id | String | The application ID for AZURE_CLOUD integration. | |
| tenant_id | String | The tenant ID for AZURE_CLOUD integration. | |
| password | String | The password for AZURE_CLOUD, UPCLOUD and DOCKER_HUB integrations. | |
| api_key | String | The API key from the account for CLOUDFLARE integration. The alternative option to add it besides using the token. | |
| role_assumptions | String | The list of role assumptions for AMAZON integration. | |
| String | Email for CLOUDFLARE integration. Required if api_key is sent. |
Role assumptions
| Name | Type | Description | |
|---|---|---|---|
arn Required | String | Role arn to assume. | |
external_id Required | String | The external ID for the role. | |
| duration | Integer | Maximum 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}
GitHub
Bitbucket
Email