Update Jira integration

Update an existing Jira integration. Send only the parameters you wish to change (eg. name).

PATCH https://uptime.betterstack.com/api/v2/jira-integrations/{jira_integration_id}

URL parameters

jira_integration_id

required string

The ID of the Jira integration you want to update

Headers

Authorization

required string

Bearer $TOKEN

Content_Type

string

application/json

Body parameters

name

string

The name of the Jira integration that you can see in the dashboard.

automatic_issue_creation

boolean

Create a Jira issue every time an incident occurs.

jira_project_key

string

The key of the target Jira project, e.g. ABC for issues like ABC-123.

jira_issue_type_id

string

The ID of the target Jira issue type.

jira_fields

object

Values used when creating a Jira issue, keyed by Jira field id. See Updating Jira issue fields below.

200

Returns the Jira integration

Response body

{
  "data": {
    "id": "13760",
    "type": "jira_integration",
    "attributes": {
      "name": "Test",
      "automatic_issue_creation": false,
      "jira_project_key": "TP",
      "jira_issue_type_id": "10006",
      "jira_fields": {
        "labels": [
          {
            "label": "example-label",
            "value": "example-label"
          }
        ],
        "assignee": {
          "label": "John Doe",
          "value": "1234567890"
        },
        "reporter": {
          "label": "John Doe",
          "value": "1234567890"
        },
        "customfield_10015": 3,
        "customfield_10021": [
          {
            "label": "Impediment",
            "value": "10019"
          }
        ]
      },
      "team_name": "Test Team"
    }
  }
}

422

Returned when the Jira project key doesn't exist. The message lists the keys available in your Jira.

Response body

{
  "errors": "Couldn't find jira_project_key = \"OPS\". Available project keys are \"ABC\" and \"TST\"."
}

422

Returned when a jira_fields value has a wrong shape. The message names the offending fields, and Jira's own validation errors are passed through.

Response body

{
  "errors": "Invalid data for jira_fields. Fields with invalid data: labels"
}

Example cURL

Rename the integration Update Jira issue fields

Copied!

curl -X "PATCH" "https://uptime.betterstack.com/api/v2/jira-integrations/13755" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "name": "Different name"
}'

curl -X "PATCH" "https://uptime.betterstack.com/api/v2/jira-integrations/13755" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "jira_fields": {
    "labels": [{ "label": "outage", "value": "outage" }],
    "assignee": { "label": "John Doe", "value": "5b10ac8d82e05b22cc7d4ef5" }
  }
}'

Updating Jira issue fields

jira_fields are the values used when creating a Jira issue, keyed by Jira field id. Most values are objects with a value and a label. The value is the id of the option in Jira and the label is the name shown in the Better Stack dashboard. Fields accepting multiple values, like labels or components, take an array of these objects. Text fields take plain strings and number fields take numbers.

The easiest way to get the right values is to set up the integration in the Better Stack dashboard first. The form loads available projects, issue types, users, and fields directly from Jira. Then fetch the integration using Get a single Jira integration and use the returned jira_fields as a template.

Looking for a Jira ID?

jira_project_key is the prefix of your Jira issue keys, e.g. ABC in ABC-123. Using a wrong key returns an error listing the available keys.

Find jira_issue_type_id using Jira's issue types API.

Find account ids for assignee and reporter in the URL of a Jira profile, or using Jira's user search API.

Find customfield_* ids using Jira's fields API.

Get Jira integration

Response attributes

Explore documentation

Update Jira integration

Example cURL

Updating Jira issue fields

Looking for a Jira ID?

Please accept cookies