Jump to

• Request
• Response

GetTsigKey

get

/20180115/tsigKeys/{tsig_key_id}

Gets information about the specified TSIG key.

Request

Supported Media Types

• application/json

Path Parameters

• tsigKeyId(required): string
  The OCID of the target TSIG key.

Query Parameters

• scope: string
  Specifies to operate only on resources that have a matching DNS scope.

  Allowed Values: [ "GLOBAL", "PRIVATE" ]

Header Parameters

• If-Modified-Since: string
  The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
• if-none-match: string
  The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag

  Default Value:
• opc-request-id: string
  Minimum Length: 1

  Maximum Length: 98

  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response containing a single TSIG key object.

Headers

• ETag: string
  The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : TsigKey

Type: object

A TSIG key. Avoid entering confidential information when you supply string values using the API.

Show Source

• algorithm(required): string
  Minimum Length: 1

  Maximum Length: 63

  Pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$

  TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see [RFC 4635](https://tools.ietf.org/html/rfc4635#section-2).
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the TSIG key.
• definedTags(required): object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• freeformTags(required): object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the resource.
• lifecycleState(required): string
  Allowed Values: [ "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", "UPDATING" ]

  The current state of the resource.
• name(required): string
  Minimum Length: 1

  Maximum Length: 63

  Pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(?=.*\.)(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$

  A globally unique domain name identifying the key for a given pair of hosts.
• secret(required): string
  Minimum Length: 1

  Maximum Length: 255

  Pattern: ^(([\x20\t\r\n\f]*[A-Za-z0-9+/]){4})*(([\x20\t\r\n\f]*[A-Za-z0-9+/]){2}==|([\x20\t\r\n\f]*[A-Za-z0-9+/]){3}=)?[\x20\t\r\n\f]*$

  A base64 string encoding the binary shared secret.
• self(required): string(url)
  The canonical absolute URL of the resource.
• timeCreated(required): string(date-time)
  The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z
• timeUpdated: string(date-time)
  The date and time the resource was last updated, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z

{
    "description":"A TSIG key. Avoid entering confidential information when you supply string values using the API.",
    "type":"object",
    "required":[
        "algorithm",
        "name",
        "compartmentId",
        "secret",
        "freeformTags",
        "definedTags",
        "id",
        "self",
        "timeCreated",
        "lifecycleState"
    ],
    "properties":{
        "algorithm":{
            "type":"string",
            "description":"TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see [RFC 4635](https://tools.ietf.org/html/rfc4635#section-2).",
            "minLength":"1",
            "maxLength":"63",
            "pattern":"^\\.$|^(?=([^\\\\]|\\\\([^0-9]|[0-9]{3})){1,253}\\.?$)(?=.*[^\\\\0-9.])(([a-zA-Z0-9_-]|\\\\([\\x21-\\x2F\\x3A-\\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\\.|$))+$"
        },
        "name":{
            "type":"string",
            "description":"A globally unique domain name identifying the key for a given pair of hosts.",
            "minLength":"1",
            "maxLength":"63",
            "pattern":"^\\.$|^(?=([^\\\\]|\\\\([^0-9]|[0-9]{3})){1,253}\\.?$)(?=.*[^\\\\0-9.])(?=.*\\.)(([a-zA-Z0-9_-]|\\\\([\\x21-\\x2F\\x3A-\\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\\.|$))+$"
        },
        "compartmentId":{
            "description":"The OCID of the compartment containing the TSIG key.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "secret":{
            "type":"string",
            "description":"A base64 string encoding the binary shared secret.",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"^(([\\x20\\t\\r\\n\\f]*[A-Za-z0-9+/]){4})*(([\\x20\\t\\r\\n\\f]*[A-Za-z0-9+/]){2}==|([\\x20\\t\\r\\n\\f]*[A-Za-z0-9+/]){3}=)?[\\x20\\t\\r\\n\\f]*$"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer, and boolean types are supported."
                }
            }
        },
        "id":{
            "description":"The OCID of the resource.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "self":{
            "description":"The canonical absolute URL of the resource.",
            "type":"string",
            "format":"url"
        },
        "timeCreated":{
            "description":"The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z ",
            "type":"string",
            "format":"date-time"
        },
        "lifecycleState":{
            "description":"The current state of the resource.",
            "type":"string",
            "enum":[
                "ACTIVE",
                "CREATING",
                "DELETED",
                "DELETING",
                "FAILED",
                "UPDATING"
            ]
        },
        "timeUpdated":{
            "description":"The date and time the resource was last updated, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z ",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer, and boolean types are supported."
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer, and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer, and boolean types are supported."
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer, and boolean types are supported.

304 Response

Not Modified

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top