application-properties

Operations

GET/api/2/application-properties GET/api/2/application-properties/advanced-settings PUT/api/2/application-properties/{id}

GET

Get an application property by key

Returns an application property.

Request

Query parameters

permissionLevel

string

Required

keyFilter

string

key

string

Required

Responses

Returned if the property exists and the currently authenticated user has permission to view it. Contains a full representation of the property.

application/json

Property

GET/api/2/application-properties

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/application-properties?permissionLevel={permissionLevel}&key={key}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

[
  {
    "id": "jira.home",
    "key": "jira.home",
    "value": "/var/jira/jira-home",
    "name": "jira.home",
    "desc": "Jira home directory",
    "type": "string",
    "defaultValue": ""
  },
  {
    "id": "jira.clone.prefix",
    "key": "jira.clone.prefix",
    "value": "CLONE -",
    "name": "The prefix added to the Summary field of cloned issues",
    "type": "string",
    "defaultValue": "CLONE -"
  }
]

GET

Get all advanced settings properties

Returns the properties that are displayed on the "General Configuration > Advanced Settings" page.

Request

This request has no parameters.

Responses

Returns all properties to display in the "General Configuration > Advanced Settings" page.

application/json

Property

GET/api/2/application-properties/advanced-settings

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/application-properties/advanced-settings' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

[
  {
    "id": "jira.home",
    "key": "jira.home",
    "value": "/var/jira/jira-home",
    "name": "jira.home",
    "desc": "Jira home directory",
    "type": "string",
    "defaultValue": ""
  },
  {
    "id": "jira.clone.prefix",
    "key": "jira.clone.prefix",
    "value": "CLONE -",
    "name": "The prefix added to the Summary field of cloned issues",
    "type": "string",
    "defaultValue": "CLONE -"
  }
]

PUT

Update an application property

Update an application property via PUT. The "value" field present in the PUT will override the existing value.