기존 통합 엔드포인트 업데이트 예시

통합 (v1) API의 기존 통합 업데이트 엔드포인트에 대한 예시는 다음과 같습니다.

기존 통합에 대해 Broker 설정

명령

curl --include \
     --request PUT \
     --header "Content-Type: application/json; charset=utf-8" \
     --header "Authorization: token API_KEY" \
     --data-binary "{
    \"type\": \"github\",
    \"broker\": { \"enabled\": true }
}" \
'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}'

응답

{
  "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
  "brokerToken": "4a18d42f-0706-4ad0-b127-24078731fbed"
}

유형(Type)에 가능한 값

acr, artifactory-cr, azure-repos, bitbucket-cloud, bitbucket-server, digitalocean-cr, docker-hub, ecr, gcr, github, github-cr, github-enterprise, gitlab, gitlab-cr, google-artifact-cr, harbor-cr, nexus-cr, quay-cr

업데이트하려는 통합에 필요한 자격 증명

AcrCredentials: 객체(object) username: 필수(required), 문자열(string) password: 필수, 문자열 registryBase: 필수, 문자열, 예: name.azurecr.io

또는 ArtifactoryCrCredentials: 객체 username: 필수, 문자열 password: 필수, 문자열 registryBase: 필수, 문자열, 예: name.jfrog.io

또는 AzureReposCredentials: 객체 username: 필수, 문자열 url: 필수, 문자열

또는 BitbucketCloudCredentials: 객체 username: 필수, 문자열 password: 필수, 문자열

또는 BitbucketServerCredentials: 객체 username: 필수, 문자열 password: 필수, 문자열 url: 필수, 문자열

또는 DigitalOceanCrCredentials: 객체 token: 필수, 문자열, 개인 접근 토큰(Personal Access Token)

또는 DockerHubCredentials: 객체 username: 필수, 문자열 password: 필수, 문자열, 접근 토큰(Access Token)

또는 EcrCredentials: 객체 region: 필수, 문자열, 예: eu-west-3 roleArn: 필수, 문자열, 예: arn:aws:iam::<account-id>:role/<newRole>

또는 GcrCredentials: 객체 password: 필수, 문자열, JSON 키 파일 registryBase: 필수, 문자열, 예: gcr.io, us.gcr.io, eu.gcr.io, asia.gcr.io

또는 GitHubCredentials: 객체 token: 필수, 문자열

또는 GitHubCrCredentials: 객체 username: 필수, 문자열 password: 필수, 문자열 egistryBase: 필수, 문자열, 예: ghcr.io

또는 GitHubEnterpriseCredentials: 객체 token: 필수, 문자열 url: 필수, 문자열

또는 GitLabCredentials: 객체 token: 필수, 문자열 url: 문자열, 자체 호스팅(self-hosted) GitLab에만 해당

또는 GitLabCrCredentials: 객체 username: 필수, 문자열 password: 필수, 문자열 registryBase: 필수, 문자열, 예: your.gitlab.host

또는 GoogleArtifactCrCredentials: 객체 password: 필수, 문자열, JSON 키 file registryBase: 필수, 문자열, 예: us-east1-docker.pkg.dev, europe-west1-docker.pkg.dev

또는 HarborCrCredentials: 객체 username: 필수, 문자열 password: 필수, 문자열 registryBase: 필수, 문자열, 예: your.harbor.host

또는 NexusCrCredentials: 객체 username: 필수, 문자열 password: 필수, 문자열 registryBase: 필수, 문자열, 예: your.nexus.host

또는 QuayCrCredentials: 객체 username: 필수, 문자열 password: 필수, 문자열 registryBase: 필수, 문자열, 예: quay.io, your.quay.host

필요한 Snyk 권한

조직 보기 (View Organization) 통합 보기 (View Integrations) 통합 편집 (Edit Integrations)

기존의 Broker를 사용하지 않는 통합의 자격 증명 업데이트

명령

curl --include \
     --request PUT \
     --header "Content-Type: application/json; charset=utf-8" \
     --header "Authorization: token API_KEY" \
     --data-binary "{
    \"type\": \"gitlab\",
    \"credentials\": { \"token\": \"GITLAB_TOKEN\" }
}" \
'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}'

응답

{
  "id": "9a3e5d90-b782-468a-a042-9a2073736f0b"
}

유형(Type)에 가능한 값

기존 통합에 대해 Broker 설정의 값과 동일합니다.

업데이트하려는 통합에 필요한 자격 증명

기존 통합에 대해 Broker 설정의 자격 증명과 동일합니다.

필요한 Snyk 권한

조직 보기 (View Organization) 통합 보기 (View Integrations) 통합 편집 (Edit Integrations)

기존 통합에 대해 Broker 비활성화

명령

curl --include \
     --request PUT \
     --header "Content-Type: application/json; charset=utf-8" \
     --header "Authorization: token API_KEY" \
     --data-binary "{
    \"type\": \"github\",
    \"broker\": { \"enabled\": false },
    \"credentials\": { \"token\": \"GITHUB_TOKEN\" }
}" \
'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}'

응답

{
  "id": "9a3e5d90-b782-468a-a042-9a2073736f0b"
}