SupportSnyk LearnAPI referenceProduct updatesSign up for free

Pull Request Templates

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

Create or update pull request template for group

post

Configures a group level pull request template that will be used on any org or project within that group

Authorizations
Path parameters
group_idstring · uuidrequired

Snyk Group ID

Example: 7626925e-4b0f-11ee-be56-0242ac120002
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
dataobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
    "data": {
      "attributes": {
        "commit_message": "chore(deps): bump {{package_name}} from {{package_from}} to {{package_to}}",
        "description": "{{ #is_upgrade_pr }} This PR has been opened to make sure our repositories are kept up-to-date. It updates {{ package_name }} from version {{ package_from }} to version {{ package_to }}. Review relevant docs for possible breaking changes. {{ /is_upgrade_pr }}
  ",
        "title": "Snyk has created this PR to upgrade {{package_name}} from {{package_from}} to {{package_to}}."
      },
      "type": "resource"
    }
  }'
{
  "data": {
    "attributes": {
      "commit_message": "chore(deps): bump {{package_name}} from {{package_from}} to {{package_to}}",
      "description": "{{ #is_upgrade_pr }} This PR has been opened to make sure our repositories are kept up-to-date. It updates {{ package_name }} from version {{ package_from }} to version {{ package_to }}. Review relevant docs for possible breaking changes. {{ /is_upgrade_pr }}\n",
      "title": "Snyk has created this PR to upgrade {{package_name}} from {{package_from}} to {{package_to}}."
    },
    "id": "https://api.snyk.io/rest/groups/7626925e-4b0f-11ee-be56-0242ac120002/pull_request_template",
    "type": "resource"
  },
  "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"
  }
}

Pull Request Template created for group.

Get pull request template for group

get

Get your groups pull request template

Authorizations
Path parameters
group_idstring · uuidrequired

Snyk Group ID

Example: 7626925e-4b0f-11ee-be56-0242ac120002
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))?))$
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: 100 · default: 10optional

Number of results to return per page

Example: 10
Responses
curl -L \
  --url 'https://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "data": {
    "attributes": {
      "commit_message": "chore(deps): bump {{package_name}} from {{package_from}} to {{package_to}}",
      "description": "{{ #is_upgrade_pr }} This PR has been opened to make sure our repositories are kept up-to-date. It updates {{ package_name }} from version {{ package_from }} to version {{ package_to }}. Review relevant docs for possible breaking changes. {{ /is_upgrade_pr }}\n",
      "title": "Snyk has created this PR to upgrade {{package_name}} from {{package_from}} to {{package_to}}."
    },
    "id": "https://api.snyk.io/rest/groups/7626925e-4b0f-11ee-be56-0242ac120002/pull_request_template",
    "type": "resource"
  },
  "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"
  }
}

Fetch Pull Request Template for group.

Delete pull request template for group

delete

Delete your groups pull request template. This means Snyk pull requests will start to use the default template for this group.

Authorizations
Path parameters
group_idstring · uuidrequired

Snyk Group ID

Example: 7626925e-4b0f-11ee-be56-0242ac120002
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
curl -L \
  --request DELETE \
  --url 'https://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No body

The operation completed successfully with no content

PreviousProjectsNextReporting API (v1)

Last updated

Was this helpful?

Revision created

Add comment to emphasize required filters hidden in GitBook collapsed field