POST Codesign/DeleteEnvironment

Removes a CodeSign Protect Environment and related objects such as keys and certificates.

Requirements

  • Permissions:  The caller must be a Code Signing Administrator, or a Owner.
  • 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 one of the following:

Input parameters

Name

Description

Dn

(Optional) The Distinguished Name (DN) of the signing collection. Use the appropriate syntax. For example, in Postman: \\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection].

Guid

(Optional) The Distinguished Name (DN) of the signing collection. Use the appropriate syntax. For example, in Postman: \\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection].

Id

(Optional)The signing project 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 a signing Environment

Request

POST https://codesign.venafi.example/vedsdk/Codesign/DeleteEnvironment
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Guid":"{e76d507d-fb6d-4197-bad5-f25ff5ca0d90}"
}

Response

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