Install Self-Hosted
Get Started on Cloud
BasicsPipelinesActions & ServicesIntegrationsSelf-HostedYAMLBuddy GitTroubleshootingAPI

Create

  • POST
  • /workspaces
  • /:domain
  • /integrations

Creates an integration of the selected type.

Supported integration types: DIGITAL_OCEAN, AMAZON, SHOPIFY, PUSHOVER, RACKSPACE, CLOUDFLARE, NEW_RELIC, SENTRY, ROLLBAR, DATADOG, DO_SPACES, HONEYBADGER, VULTR, SENTRY_ENTERPRISE, LOGGLY, FIREBASE, UPCLOUD, GHOST_INSPECTOR, AZURE_CLOUD, DOCKER_HUB, GIT_HUB, GOOGLE_SERVICE_ACCOUNT.

Request

REQUIRED SCOPES
INTEGRATION_ADD
url PARAMETERS
domainrequired string
The workspace domain.
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 one of: PRIVATE, PRIVATE_IN_PROJECT WORKSPACE, ADMIN, GROUP, PROJECT, ADMIN_IN_PROJECT or GROUP_IN_PROJECT.
project_nameoptional string
The name of the project. Required if scope is set to PROJECT, PRIVATE_IN_PROJECT, ADMIN_IN_PROJECT or GROUP_IN_PROJECT.
group_idoptional integer
The ID of the group. Required if scope is set to GROUP or GROUP_IN_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, GIT_HUB.
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 or 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. For GOOGLE_SERVICE_ACCOUNT integration type it's the service account key (JSON format).
role_assumptionsoptional string
The list of role assumptions for AMAZON integration.
arnrequired string
The role arn for assumption.
external_idoptional string
The external ID for the role. Required if the auth_type is NOT OIDC (i.e. for default type).
durationoptional integer
Maximum session duration setting for the role. Can have values between 900 and 43200.
emailoptional string
Email for CLOUDFLARE integration. Required if api_key is sent.
partner_tokenoptional string
The partner token for SHOPIFY integration.
key_idoptional string
The access key for BACKBLAZE integration.
application_keyoptional string
The secret key for BACKBLAZE integration.
auth_typeoptional string
The authorization method for the integration. Available values: OAUTH, TOKEN, API_KEY, APP, APP_SPRYKER, TOKEN_APP_EXTENSION, DEFAULT, OIDC, TRUSTED.
google_projectoptional string
The ID of the Google Cloud project. Required for GOOGLE_SERVICE_ACCOUNT integration type with OIDC auth_type.
configoptional string
Client library config (JSON format). Required for GOOGLE_SERVICE_ACCOUNT integration type with OIDC auth_type.
audienceoptional string
OIDC audience for integrations with OIDC auth_type.

Last modified on Sep 23, 2024

Previous pageDeleteNext pageGet
{
  "name": "Buddy AWS integration",
  "type": "AMAZON",
  "scope": "PROJECT",
  "project_name": "theproject",
  "access_key": "AKIAVASPKE3ZWWV7V5BI",
  "secret_key": "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",
  "role_assumptions": [
    {
      "arn": "arn:aws:iam::123457465779:role/TESTS",
      "external_id": "ext_id",
      "duration": 9000
    }
  ]
}
{
  "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_name": "theproject"
}