POST Codesign/DeleteTemplate

Removes a CodeSign Protect Environment Template.

Requirements

  • Permissions

    The caller must be a Code Signing Administrator or application administrator.

  • Token scope:  Codesign:Delete

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

Specify Dn, Guid, or Id

Input parameters

Name

Description

Dn

The Distinguished Name (DN) of the environment template. Use the appropriate syntax. For example, in Postman: \\VED\\Code Signing\\Environment Templates\\[YourTemplateName].

Force

(Optional) The setting to control deletion while the template is in use:

true: Force deletion even if the template is in use.

false: Retain the template if it is in use.

Guid

The GUID that uniquely identifies the Environment template.

Id

The Environment Template identifier.

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 Success is false. An error message that accompanies the Result. Check your payload input values.
  • Result: The Result code of this API call. For more information, see Sign Result Codes.

  • Success: The result of this API call: A value of false indicates the request failed due to an Error. Otherwise, true.

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: Remove an Environment template

Request

POST https://codesign.venafi.example/vedsdk/Codesign/DeleteTemplate
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Dn": "\\VED\\Code Signing\\Environment Templates\\MyTemplate3"
}  

Response

HTTP/1.1 200 OK
{
   "Result": 1,
   "Success": true
}