Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
  • backlog
  • board
  • epic
  • issue
  • sprint
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index-snapshot
  • index
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • securitylevel
  • serverInfo
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • workflow
  • workflowscheme
  • worklog
  • session
  • websudo
Server
Jira Data Center / / Modules

application-properties

Postman Collection
OpenAPI
GET

Get an application property by key

Returns an application property.

Forge and OAuth2 apps cannot access this REST resource.

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
1 2 3 4 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 [ { "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.

Forge and OAuth2 apps cannot access this REST resource.

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
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/application-properties/advanced-settings' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 [ { "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.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Responses

Returned if the property exists and the currently authenticated user has permission to edit it.

application/json

Property
PUT/api/2/application-properties/{id}
1 2 3 4 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/application-properties/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'

Rate this page: