tsig

Returns the details of a specific TSIG key.

This endpoint returns the details of a specific TSIG key, enabling users to review and manage its configuration.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive error handling: Returns a 404 error code with a clear description when requests fail.</br>- Targeted data retrieval: Employs the tsigId parameter to return the specified TSIG key's details, ensuring accuracy and relevance in the response.

get/tsig/{tsigId}

Request

Path parameters

tsigIdinteger required

Filters data by the TSIG key’s unique identifier.

Response

TSIG key returned successfully.

idinteger
namestring
tsigAlgorithmstring
tsigSecretstring
createdTsstring
modifiedTsstring

Example response

{
  "id": 1,
  "name": "MyIPSet",
  "tsigAlgorithm": "hmac-sha256",
  "tsigSecret": "bMXYjKzZq6eW0bJY9S4TbXnDylK2gpoDQ7kY5XyW3OY=",
  "createdTs": "2024-02-01 14:02:58.325993",
  "modifiedTs": "2024-02-01 14:02:58.325993",
  "domains": [
    {
      "id": 1,
      "name": "example.com"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.