• 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
  • issueLink
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • search
  • securitylevel
  • serverInfo
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • workflow
  • workflowscheme
  • worklog
  • session
  • websudo
Server
Jira Data Center / / Modules

monitoring

Postman Collection
OpenAPI
Operations
GET/api/2/monitoring/appPOST/api/2/monitoring/appGET/api/2/monitoring/ipdPOST/api/2/monitoring/ipdGET/api/2/monitoring/jmx/areMetricsExposedGET/api/2/monitoring/jmx/getAvailableMetricsPOST/api/2/monitoring/jmx/startExposingPOST/api/2/monitoring/jmx/stopExposing
GET

Get App Monitoring status

Checks if App Monitoring is enabled

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns the status of App Monitoring.

application/json

AppMonitoringRestEntity
GET/api/2/monitoring/app
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/monitoring/app' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Update App Monitoring status

Enables or disables App Monitoring

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

The status to set for App Monitoring.

enabled

boolean

Responses

Sets the status of App Monitoring.

POST/api/2/monitoring/app
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/monitoring/app' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
GET

Get if IPD Monitoring is enabled

Checks if IPD Monitoring is enabled

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns the status of IPD Monitoring.

application/json

IpdMonitoringRestEntity
GET/api/2/monitoring/ipd
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/monitoring/ipd' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Update IPD Monitoring status

Enables or disables IPD Monitoring

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

The status to set for IPD Monitoring.

enabled

boolean

Responses

Confirmation that the status was set.

POST/api/2/monitoring/ipd
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/monitoring/ipd' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
GET

Check if JMX metrics are being exposed

Checks if JMX metrics are being exposed

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns whether JMX metrics are being exposed.

application/json

boolean

GET/api/2/monitoring/jmx/areMetricsExposed
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/monitoring/jmx/areMetricsExposed' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get the available JMX metrics

Gets the available JMX metrics

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns the available JMX metrics.

application/json

string

GET/api/2/monitoring/jmx/getAvailableMetrics
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/monitoring/jmx/getAvailableMetrics' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 "<string>"
POST

Start exposing JMX metrics

Starts exposing JMX metrics

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Confirmation that the JMX metrics are being exposed.

POST/api/2/monitoring/jmx/startExposing
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/api/2/monitoring/jmx/startExposing' \ --user 'email@example.com:<api_token>'
POST

Stop exposing JMX metrics

Stops exposing JMX metrics

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Confirmation that the JMX metrics are no longer being exposed.

POST/api/2/monitoring/jmx/stopExposing
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/api/2/monitoring/jmx/stopExposing' \ --user 'email@example.com:<api_token>'

Rate this page: