POST Config/GetHighestRevision

Returns the highest revision number for the specified revision branch. Every Trust Protection Platform object has revision tracking. If an object is updated in any way, the revision number increments.

Requirements

  • Permissions:  The caller must have Read permission to the requested container object.
  • Token scope:  Configuration

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters

Name

Description

ObjectDN

The Distinguished Name (DN) of the object, such as, a policy or certificate.

Classes (Optional)

The list of classes to consider when looking for revisions.

Returns

Response description

Name

Description

HTTP 200

For valid requests, this call returns a HTTP 200 message and the following data in the message body:

  • Error: Appears only when the operation cannot supply the necessary data. Provides only a description and Result. No other data.
  • Result: The result code that indicates the reason for success or failure. For more information, see Config result codes.

  • Revision: The highest revision number found. The Revision element will not be contained in the response if its Result is 0 (failure).

HTTP 400

For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:

  • error: The reason for the error.
  • error_description: If available, additional information about how to retry the request.

Example: Show highest revision for a DN

Request

POST https://tpp.venafi.example/vedsdk/Config/GetHighestRevision
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Policy\\Certificates",
   "Classes":[
      "Policy",
      "X509 Certificate"
   ]
}

Response

HTTP/1.1 200 OK
{
   "Result":1,
   "Revision":9
}