Try it free

Anonymization API - GET job status

  • Reference
  • Published Sep 10, 2019

Checks the status of an anonymization job. The response contains the percentage of job progress.

  • -1: The job is waiting for execution. Anonymization jobs run one at a time, so a job can wait while other jobs are processed. Don't submit the anonymization request again.
  • 0 to 100: The percentage of the job that is complete.

If the requestId contains several IDs separated by | (for multiple data centers), pass the full value. The response contains the average progress across all data centers.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}

Authentication

Api-Token:

To execute this request, you need an access token with UserSessionAnonymization scope.

To learn how to obtain and use it, see Personal access tokens.

Parameters

ParameterTypeDescriptionInRequired
requestIdstring

The ID of the required anonymization job.

pathRequired

Response

Response codes

CodeTypeDescription
200AnonymizationProgressResult

Success. The response body contains the status of the anonymization job.

400-

Failed. The input is invalid. See the response body for details.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The AnonymizationProgressResult object

ElementTypeDescription
progressinteger

The progress of the anonymization job, percent.

-1 if the job is waiting for execution.

Response body JSON models

{
"progress": 50
}

Example

In this example, the request checks the status of the anonymization job with the ID of 7810238295331327902.

The API token is passed in the Authorization header.

The response shows that the job is complete.

Curl

curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/v1/anonymize/anonymizationJobs/7810238295331327902 \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/anonymize/anonymizationJobs/7810238295331327902

Response content

{
"progress": 100
}

Response code

200