Integrations

This document uses the REST API. For more details, see the Authentication for API page.

Create an integration for an organization (Early Access)

post

Create a new integration with specified credentials and profile name

Required permissions

• Edit integrations (org.integration.edit)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The organization public ID

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Body

application/vnd.api+json

Request body for creating an integration

Responses

201

Integration successfully created

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

409

Conflict: The requested operation conflicts with the current state of the resource in some way.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/orgs/{org_id}/integrations

HTTPcURLJavaScriptPython

POST /rest/orgs/{org_id}/integrations?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 201

{
  "data": {
    "attributes": {
      "credentials": {
        "region": "us-east-1",
        "role_arn": "arn:aws:iam::123456789012:role/SnykEcrRole"
      },
      "integration_type": "ecr",
      "profile_name": "my-aws-prod-account"
    },
    "type": "integration"
  }
}

{
  "data": {
    "attributes": {
      "created_at": "2025-10-31T10:30:00Z",
      "has_broker": false,
      "integration_type": "acr",
      "profile_name": "my-aws-prod-account",
      "updated_at": "2025-10-31T10:30:00Z"
    },
    "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
    "relationships": {
      "org": {
        "data": {
          "id": "331ede0a-de94-468a-a042-9a2073736f0b",
          "type": "org"
        }
      }
    },
    "type": "integration"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

List all integrations for an organization (Early Access)

get

Get all integrations for an organization with cursor-based pagination

Required permissions

• View integrations (org.integration.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The organization public ID

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

starting_afterstringOptional

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=

ending_beforestringOptional

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=

limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10

Responses

200

List of integrations successfully retrieved

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/integrations

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/integrations?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "created_at": "2025-10-31T10:30:00Z",
        "has_broker": false,
        "integration_type": "acr",
        "profile_name": "my-aws-prod-account",
        "updated_at": "2025-10-31T10:30:00Z"
      },
      "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
      "relationships": {
        "org": {
          "data": {
            "id": "331ede0a-de94-468a-a042-9a2073736f0b",
            "type": "org"
          }
        }
      },
      "type": "integration"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
    "last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
    "next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
  }
}

Update an existing integration (Early Access)

patch

Update attributes of an integration. Supports partial updates - only provided fields will be modified.

Updateable fields:

• profile_name: Change the user-defined name for the integration
• credentials: Update AWS region, IAM role ARN, or both

Immutable fields:

• integration_type: Cannot be changed after creation

Only include fields you want to update in the request body. Omitted fields remain unchanged.

Required permissions

• Edit integrations (org.integration.edit)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The organization public ID

integration_idstring · uuidRequired

The unique identifier for the integration

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Body

application/vnd.api+json

Request body for updating an integration (partial update supported)

Responses

200

Integration successfully updated

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

409

Conflict: The requested operation conflicts with the current state of the resource in some way.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/orgs/{org_id}/integrations/{integration_id}

HTTPcURLJavaScriptPython

PATCH /rest/orgs/{org_id}/integrations/{integration_id}?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 220

{
  "data": {
    "attributes": {
      "credentials": {
        "region": "us-east-1",
        "role_arn": "arn:aws:iam::123456789012:role/SnykEcrRole"
      },
      "profile_name": "my-aws-prod-account"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "integration"
  }
}

{
  "data": {
    "attributes": {
      "created_at": "2025-10-31T10:30:00Z",
      "has_broker": false,
      "integration_type": "acr",
      "profile_name": "my-aws-prod-account",
      "updated_at": "2025-10-31T10:30:00Z"
    },
    "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
    "relationships": {
      "org": {
        "data": {
          "id": "331ede0a-de94-468a-a042-9a2073736f0b",
          "type": "org"
        }
      }
    },
    "type": "integration"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get a specific integration (Early Access)

get

Retrieve details for a single integration by its ID

Required permissions

• View integrations (org.integration.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The organization public ID

integration_idstring · uuidRequired

The unique identifier for the integration

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

200

Integration successfully retrieved

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/integrations/{integration_id}

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/integrations/{integration_id}?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "created_at": "2025-10-31T10:30:00Z",
      "has_broker": false,
      "integration_type": "acr",
      "profile_name": "my-aws-prod-account",
      "updated_at": "2025-10-31T10:30:00Z"
    },
    "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
    "relationships": {
      "org": {
        "data": {
          "id": "331ede0a-de94-468a-a042-9a2073736f0b",
          "type": "org"
        }
      }
    },
    "type": "integration"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Delete an integration (Early Access)

delete

Permanently delete a container registry integration from an organization. Brokered integrations must have broker mode disabled via the V1 API first. NOTE: This endpoint performs a hard delete of the integration. The integration will be permanently removed from the database and all associated targets and projects will be orphaned and need to be manually removed.

Required permissions

• Edit integrations (org.integration.edit)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The organization public ID

integration_idstring · uuidRequired

The unique identifier for the integration

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

204

Integration successfully deleted. No content is returned.

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

delete

/orgs/{org_id}/integrations/{integration_id}

HTTPcURLJavaScriptPython

DELETE /rest/orgs/{org_id}/integrations/{integration_id}?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Update integration settings (Early Access)

patch

Update the settings for a specific integration. Supports partial updates.

Updateable fields:

• container_app_scan_enabled: Enable or disable container application scanning (only applicable to container registry integrations)

Required permissions

• Edit integrations (org.integration.edit)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The organization public ID

integration_idstring · uuidRequired

The unique identifier for the integration

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Body

application/vnd.api+json

Request body for updating integration settings

Responses

200

Integration settings successfully updated

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/orgs/{org_id}/integrations/{integration_id}/settings

HTTPcURLJavaScriptPython

PATCH /rest/orgs/{org_id}/integrations/{integration_id}/settings?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 133

{
  "data": {
    "attributes": {
      "container_app_scan_enabled": true
    },
    "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
    "type": "integration_settings"
  }
}

{
  "data": {
    "attributes": {
      "container_app_scan_enabled": true
    },
    "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
    "type": "integration_settings"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get integration settings (Early Access)

get

Get the settings for a specific integration.

Required permissions

• View integrations (org.integration.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The organization public ID

integration_idstring · uuidRequired

The unique identifier for the integration

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

starting_afterstringOptional

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=

ending_beforestringOptional

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=

limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10

Responses

200

Integration settings successfully retrieved

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/integrations/{integration_id}/settings

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/integrations/{integration_id}/settings?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "container_app_scan_enabled": true
    },
    "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
    "type": "integration_settings"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}