REST API for Oracle Private Cloud Appliance Compute Enclave

ListTsigKeys

get

/20180115/tsigKeys

Gets a list of all TSIG keys in the specified compartment.

Request

Supported Media Types

application/json

Query Parameters

compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment.
id: string

Minimum Length: 1

Maximum Length: 255

The OCID of a resource.
lifecycleState: string

The state of a resource.
limit: integer

Minimum Value: 1

Maximum Value: 1000

For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

Default Value: 100
name: string

Minimum Length: 1

Maximum Length: 255

The name of a resource.
page: string

Minimum Length: 1

Maximum Length: 512

For list pagination. The value of the opc-next-page response header from the previous List call.

Default Value: oracle.doceng.json.BetterJsonNull@2c07545f
scope: string

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

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

The field by which to sort TSIG keys. If unspecified, defaults to timeCreated.

Default Value: timeCreated

Allowed Values: [ "name", "timeCreated" ]
sortOrder: string

The sort order to use, either ascending (ASC) or descending (DESC).

Allowed Values: [ "ASC", "DESC" ]

Header Parameters

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.

Response

Supported Media Types

application/json

200 Response

A response containing a list of TSIG keys.

Headers

opc-next-page: string

For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
opc-request-id: string

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

Root Schema : schema

Type: array

Show Source

Array of: object TsigKeySummary

A TSIG key.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TsigKeySummary"
    }
}

Nested Schema : TsigKeySummary

Type: object

A TSIG key.

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.
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

{
    "description":"A TSIG key.",
    "type":"object",
    "required":[
        "algorithm",
        "name",
        "compartmentId",
        "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"
        },
        "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"
            ]
        }
    }
}

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.

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.

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.

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.

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.

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.

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.

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."
        }
    }
}