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

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

POSThttps://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template

Path parameters

group_id*string (uuid)

Snyk Group ID

Example: "7626925e-4b0f-11ee-be56-0242ac120002"

Query parameters

Body

data*object

Response

Pull Request Template created for group.

Headers

Body

dataobject

Create or update Pull Request Template response

jsonapiJsonApi (object)

linksPaginatedLinks (object)

Request

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "resource",
        "attributes": {}
      }
    }),
});
const data = await response.json();

Response

{
  "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"
  }
}

Get pull request template for group

Get your groups pull request template

GEThttps://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template

Path parameters

group_id*string (uuid)

Snyk Group ID

Example: "7626925e-4b0f-11ee-be56-0242ac120002"

Query parameters

Response

Fetch Pull Request Template for group.

Headers

Body

dataobject

Fetch a pull request template response

jsonapiJsonApi (object)

linksPaginatedLinks (object)

Request

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  }
}

Delete pull request template for group

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

DELETEhttps://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template

Path parameters

group_id*string (uuid)

Snyk Group ID

Example: "7626925e-4b0f-11ee-be56-0242ac120002"

Query parameters

Response

The operation completed successfully with no content

Headers

Request

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template?version=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

PreviousProjects NextReporting API (v1)

Last updated 3 months ago

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/settings/pull_request_template?version=text', { method: 'POST', headers: { "Content-Type": "application/vnd.api+json" }, body: JSON.stringify({ "data": { "type": "resource", "attributes": {} } }), }); const data = await response.json();

{ "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" } }