Jump to

• Request
• Response

GetSecurityList

get

/20160918/securityLists/{security_list_id}

Get the specified security list's information.

Request

Supported Media Types

• application/json

Path Parameters

• securityListId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the security list.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The security list was retrieved.

Headers

• etag: string
  For optimistic concurrency control. See if-match.
• 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 : SecurityList

Type: object

A set of virtual firewall rules for your VCN. Security lists are configured at the subnet level, but the rules are applied to the ingress and egress traffic for the individual instances in the subnet. The rules can be stateful or stateless.

Note: Compare security lists to NetworkSecurityGroups, which let you apply a set of security rules to a specific set of VNICs instead of an entire subnet. Oracle recommends using network security groups instead of security lists, although you can use either or both together.

Important: Private Cloud Appliance Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure both the security lists associated with the instance's subnet and the instance's firewall rules are set correctly. To use any of the API operations, you must be authorized in an IAM policy.

Show Source

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the security list.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace.
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• egressSecurityRules(required): array egressSecurityRules
  Rules for allowing egress IP packets.
• freeformTags: 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 security list's OCID.
• ingressSecurityRules(required): array ingressSecurityRules
  Rules for allowing ingress IP packets.
• lifecycleState(required): string
  Allowed Values: [ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" ]

  The security list's current state.
• timeCreated(required): string(date-time)
  The date and time the security list was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
• vcnId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the VCN the security list belongs to.

{
    "description":"A set of virtual firewall rules for your VCN. Security lists are configured at the subnet level, but the rules are applied to the ingress and egress traffic for the individual instances in the subnet. The rules can be stateful or stateless.<p>Note: Compare security lists to NetworkSecurityGroups, which let you apply a set of security rules to a specific set of VNICs instead of an entire subnet. Oracle recommends using network security groups instead of security lists, although you can use either or both together.<p>Important: Private Cloud Appliance Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure both the security lists associated with the instance's subnet and the instance's firewall rules are set correctly. To use any of the API operations, you must be authorized in an IAM policy.",
    "x-obmcs-splat":{
        "resourceKind":"security-list",
        "adLocality":"regional"
    },
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment containing the security list.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "egressSecurityRules":{
            "description":"Rules for allowing egress IP packets.",
            "items":{
                "$ref":"#/definitions/EgressSecurityRule"
            },
            "type":"array"
        },
        "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"
            }
        },
        "id":{
            "description":"The security list's OCID.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "ingressSecurityRules":{
            "description":"Rules for allowing ingress IP packets.",
            "items":{
                "$ref":"#/definitions/IngressSecurityRule"
            },
            "type":"array"
        },
        "lifecycleState":{
            "description":"The security list's current state.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED"
            ],
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the security list was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "vcnId":{
            "description":"The OCID of the VCN the security list belongs to.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "compartmentId",
        "displayName",
        "egressSecurityRules",
        "id",
        "ingressSecurityRules",
        "lifecycleState",
        "timeCreated",
        "vcnId"
    ],
    "x-example":"{   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"displayName\": \"MyPrivateSubnetSecurityList\",   \"egressSecurityRules\": [{     \"destination\": \"10.0.2.0/24\",     \"protocol\": \"6\",     \"tcpOptions\": {       \"destinationPortRange\": {         \"max\": 1521,         \"min\": 1521       }     }   }],   \"id\": \"ocid1.securitylist.<var>unique_ID</var>\",   \"ingressSecurityRules\": [{     \"protocol\": \"6\",     \"source\": \"10.0.1.0/24\",     \"tcpOptions\": {       \"destinationPortRange\": {         \"max\": 1521,         \"min\": 1521       }     }   },{     \"protocol\": \"6\",     \"source\": \"10.0.2.0/24\",     \"tcpOptions\": {       \"destinationPortRange\": {         \"max\": 1521,         \"min\": 1521       }     }   }],   \"lifecycleState\": \"AVAILABLE\",   \"timeCreated\": \"2016-12-14T21:02:46.357Z\",   \"vcnId\": \"ocid1.vcn.<var>unique_ID</var>\" } ",
    "type":"object"
}

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.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : egressSecurityRules

Type: array

Rules for allowing egress IP packets.

Show Source

• Array of: object EgressSecurityRule
  A rule for allowing outbound IP packets.

{
    "description":"Rules for allowing egress IP packets.",
    "items":{
        "$ref":"#/definitions/EgressSecurityRule"
    },
    "type":"array"
}

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 : ingressSecurityRules

Type: array

Rules for allowing ingress IP packets.

Show Source

• Array of: object IngressSecurityRule
  A rule for allowing inbound IP packets.

{
    "description":"Rules for allowing ingress IP packets.",
    "items":{
        "$ref":"#/definitions/IngressSecurityRule"
    },
    "type":"array"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : EgressSecurityRule

Type: object

A rule for allowing outbound IP packets.

Show Source

• description: string
  Minimum Length: 1

  Maximum Length: 255

  An optional description of your choice for the rule.
• destination(required): string
  This is the range of IP addresses that a packet originating from the instance can go to. The following values are allowed:
• An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56
• The cidrBlock value for a Service, if you're setting up a security rule for traffic destined for a particular Service through a service gateway.

destinationType: string

Default Value: CIDR_BLOCK

Allowed Values: [ "CIDR_BLOCK", "SERVICE_CIDR_BLOCK" ]

Type of destination for the rule. The default value is CIDR_BLOCK. The following values are allowed:

CIDR_BLOCK: If the rule's destination is an IP address range in CIDR notation.

SERVICE_CIDR_BLOCK: If the rule's destination is the cidrBlock value for a Service (the rule is for traffic destined for a particular Service through a service gateway).

icmpOptions: object IcmpOptions

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) - [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security list rule for each.

isStateless: boolean

A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.

protocol(required): string

The transport protocol. Specify either all or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").

tcpOptions: object TcpOptions

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

udpOptions: object UdpOptions

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

{
    "description":"A rule for allowing outbound IP packets.",
    "properties":{
        "destination":{
            "description":"This is the range of IP addresses that a packet originating from the instance can go to. The following values are allowed:<li>An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56<li>The cidrBlock value for a Service, if you're setting up a security rule for traffic destined for a particular Service through a service gateway.",
            "type":"string"
        },
        "destinationType":{
            "default":"CIDR_BLOCK",
            "description":"Type of destination for the rule. The default value is CIDR_BLOCK. The following values are allowed:<li>CIDR_BLOCK: If the rule's destination is an IP address range in CIDR notation.<li>SERVICE_CIDR_BLOCK: If the rule's destination is the cidrBlock value for a Service (the rule is for traffic destined for a particular Service through a service gateway).",
            "enum":[
                "CIDR_BLOCK",
                "SERVICE_CIDR_BLOCK"
            ],
            "type":"string"
        },
        "icmpOptions":{
            "$ref":"#/definitions/IcmpOptions"
        },
        "isStateless":{
            "description":"A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.",
            "type":"boolean"
        },
        "protocol":{
            "description":"The transport protocol. Specify either all or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP (\"1\"), TCP (\"6\"), UDP (\"17\"), and ICMPv6 (\"58\").",
            "type":"string"
        },
        "tcpOptions":{
            "$ref":"#/definitions/TcpOptions"
        },
        "udpOptions":{
            "$ref":"#/definitions/UdpOptions"
        },
        "description":{
            "description":"An optional description of your choice for the rule.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "destination",
        "protocol"
    ],
    "type":"object"
}

Nested Schema : IcmpOptions

Type: object

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) - [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security list rule for each.

Show Source

• code: integer
  Minimum Value: 0

  Maximum Value: 16

  The ICMP code (optional).
• type(required): integer
  Minimum Value: 0

  Maximum Value: 254

  The ICMP type.

{
    "description":"Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) - [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)  If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify multiple codes for a single type, create a separate security list rule for each.",
    "properties":{
        "code":{
            "description":"The ICMP code (optional).",
            "maximum":"16",
            "minimum":"0",
            "type":"integer"
        },
        "type":{
            "description":"The ICMP type.",
            "maximum":"254",
            "minimum":"0",
            "type":"integer"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : TcpOptions

Type: object

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

Show Source

• destinationPortRange: object PortRange
• sourcePortRange: object PortRange

{
    "description":"Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.",
    "properties":{
        "destinationPortRange":{
            "$ref":"#/definitions/PortRange"
        },
        "sourcePortRange":{
            "$ref":"#/definitions/PortRange"
        }
    },
    "type":"object"
}

Nested Schema : UdpOptions

Type: object

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

Show Source

• destinationPortRange: object PortRange
• sourcePortRange: object PortRange

{
    "description":"Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.",
    "properties":{
        "destinationPortRange":{
            "$ref":"#/definitions/PortRange"
        },
        "sourcePortRange":{
            "$ref":"#/definitions/PortRange"
        }
    },
    "type":"object"
}

Nested Schema : PortRange

Type: object

Show Source

• max(required): integer
  Minimum Value: 1

  Maximum Value: 65535

  The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
• min(required): integer
  Minimum Value: 1

  Maximum Value: 65535

  The minimum port number, which must not be greater than the maximum port number.

{
    "properties":{
        "max":{
            "description":"The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.",
            "maximum":"65535",
            "minimum":"1",
            "type":"integer"
        },
        "min":{
            "description":"The minimum port number, which must not be greater than the maximum port number.",
            "maximum":"65535",
            "minimum":"1",
            "type":"integer"
        }
    },
    "required":[
        "max",
        "min"
    ],
    "type":"object"
}

Nested Schema : IngressSecurityRule

Type: object

A rule for allowing inbound IP packets.

Show Source

• description: string
  Minimum Length: 1

  Maximum Length: 255

  An optional description of your choice for the rule.
• icmpOptions: object IcmpOptions
  Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) - [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security list rule for each.
• isStateless: boolean
  A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if ingress traffic allows TCP destination port 80, there should be an egress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.
• protocol(required): string
  The transport protocol. Specify either all or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
• source(required): string
  This is the range of IP addresses that a packet coming into the instance can come from. The following values are allowed:
• An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56
• The cidrBlock value for a Service, if you're setting up a security list rule for traffic coming from a particular Service through a service gateway.

sourceType: string

Default Value: CIDR_BLOCK

Allowed Values: [ "CIDR_BLOCK", "SERVICE_CIDR_BLOCK" ]

Type of source for the rule. The default is CIDR_BLOCK.

CIDR_BLOCK: If the rule's source is an IP address range in CIDR notation.

SERVICE_CIDR_BLOCK: If the rule's source is the cidrBlock value for a Service (the rule is for traffic coming from a particular Service through a service gateway).

tcpOptions: object TcpOptions

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

udpOptions: object UdpOptions

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

{
    "description":"A rule for allowing inbound IP packets.",
    "properties":{
        "icmpOptions":{
            "$ref":"#/definitions/IcmpOptions"
        },
        "isStateless":{
            "description":"A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if ingress traffic allows TCP destination port 80, there should be an egress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.",
            "type":"boolean"
        },
        "protocol":{
            "description":"The transport protocol. Specify either all or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP (\"1\"), TCP (\"6\"), UDP (\"17\"), and ICMPv6 (\"58\").",
            "type":"string"
        },
        "source":{
            "description":"This is the range of IP addresses that a packet coming into the instance can come from. The following values are allowed:<li>An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56<li>The cidrBlock value for a Service, if you're setting up a security list rule for traffic coming from a particular Service through a service gateway.",
            "type":"string"
        },
        "sourceType":{
            "default":"CIDR_BLOCK",
            "description":"Type of source for the rule. The default is CIDR_BLOCK.<li>CIDR_BLOCK: If the rule's source is an IP address range in CIDR notation.<li>SERVICE_CIDR_BLOCK: If the rule's source is the cidrBlock value for a Service (the rule is for traffic coming from a particular Service through a service gateway).",
            "enum":[
                "CIDR_BLOCK",
                "SERVICE_CIDR_BLOCK"
            ],
            "type":"string"
        },
        "tcpOptions":{
            "$ref":"#/definitions/TcpOptions"
        },
        "udpOptions":{
            "$ref":"#/definitions/UdpOptions"
        },
        "description":{
            "description":"An optional description of your choice for the rule.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "protocol",
        "source"
    ],
    "type":"object"
}

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

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