Support Snyk Learn API reference Product updates Sign up for free

IacSettings

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

PreviousGroups NextIgnores (v1)

Last updated 6 months ago

Was this helpful?

Update the Infrastructure as Code Settings for an org

Update the Infrastructure as Code Settings for an org.

patch

/orgs/{org_id}/settings/iac

Authorizations

Path parameters

org_idstring · uuidrequired

The id of the org whose Infrastructure as Code settings are getting updated

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(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

dataobject

The Infrastructure as Code settings for an org.

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/settings/iac?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"iac_settings","attributes":{"custom_rules":{"inherit_from_parent":"group","is_enabled":true,"oci_registry_tag":"latest","oci_registry_url":"https://registry-1.docker.io/account/bundle"}}}}'

200

400

401

403

404

500

{
  "data": {
    "id": "ea536a06-0566-40ca-b96b-155568aa2027",
    "type": "iac_settings",
    "attributes": {
      "custom_rules": {
        "inherit_from_parent": "group",
        "is_enabled": true,
        "oci_registry_tag": "latest",
        "oci_registry_url": "https://registry-1.docker.io/account/bundle",
        "updated": "2021-11-12T10:31:06.026Z",
        "parents": {
          "group": {
            "updated": "2021-11-12T10:31:06.026Z",
            "custom_rules": {
              "is_enabled": true,
              "oci_registry_tag": "latest",
              "oci_registry_url": "https://registry-1.docker.io/account/bundle"
            }
          }
        }
      }
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

The Infrastructure as Code Settings of the org were updated.

Get the Infrastructure as Code Settings for an org.

get

/orgs/{org_id}/settings/iac

Authorizations

Path parameters

org_idstring · uuidrequired

The id of the org whose Infrastructure as Code settings are requested.

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(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

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/settings/iac?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

500

{
  "data": {
    "id": "ea536a06-0566-40ca-b96b-155568aa2027",
    "type": "iac_settings",
    "attributes": {
      "custom_rules": {
        "inherit_from_parent": "group",
        "is_enabled": true,
        "oci_registry_tag": "latest",
        "oci_registry_url": "https://registry-1.docker.io/account/bundle",
        "updated": "2021-11-12T10:31:06.026Z",
        "parents": {
          "group": {
            "updated": "2021-11-12T10:31:06.026Z",
            "custom_rules": {
              "is_enabled": true,
              "oci_registry_tag": "latest",
              "oci_registry_url": "https://registry-1.docker.io/account/bundle"
            }
          }
        }
      }
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

The Infrastructure as Code Settings of the org.

Update the Infrastructure as Code Settings for a group

Update the Infrastructure as Code Settings for a group.

patch

/groups/{group_id}/settings/iac

Authorizations

Path parameters

group_idstring · uuidrequired

The id of the group whose Infrastructure as Code settings are getting updated

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(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

dataobject

The Infrastructure as Code settings for a group.

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.snyk.io/rest/groups/{group_id}/settings/iac?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"iac_settings","attributes":{"custom_rules":{"is_enabled":true,"oci_registry_tag":"latest","oci_registry_url":"https://registry-1.docker.io/account/bundle"}}}}'

200

400

401

403

404

500

{
  "data": {
    "id": "ea536a06-0566-40ca-b96b-155568aa2027",
    "type": "iac_settings",
    "attributes": {
      "updated": "2021-11-12T10:31:06.026Z",
      "custom_rules": {
        "is_enabled": true,
        "oci_registry_tag": "latest",
        "oci_registry_url": "https://registry-1.docker.io/account/bundle"
      }
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

The Infrastructure as Code Settings of the group were updated.

Get the Infrastructure as Code Settings for a group

Get the Infrastructure as Code Settings for a group.

get

/groups/{group_id}/settings/iac

Authorizations

Path parameters

group_idstring · uuidrequired

The id of the group whose Infrastructure as Code settings are requested

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(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

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/rest/groups/{group_id}/settings/iac?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

500

{
  "data": {
    "id": "ea536a06-0566-40ca-b96b-155568aa2027",
    "type": "iac_settings",
    "attributes": {
      "updated": "2021-11-12T10:31:06.026Z",
      "custom_rules": {
        "is_enabled": true,
        "oci_registry_tag": "latest",
        "oci_registry_url": "https://registry-1.docker.io/account/bundle"
      }
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

The Infrastructure as Code Settings of the group.