Jump to

• Request
• Response

Retrieve the sub-element SD.access-control.destination-address

get

https://cloud-native-SBC-IP/config/v1/sd/access-control/{ElementKey}/destination-address

Retrieve the sub-element SD.access-control.destination-address

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Query Parameters

• revision-id: string
  Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return the sub-element: FlowAddress

Body ()

Root Schema : FlowAddress

Type: object

destination ip address

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• ip-address(required): string
  Minimum Length: 1
• ip-port: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  Enter a number in the range 0..65535. This will be an optional port number for both IPv4 and IPv6 addresses, (range: 0-65535 for both IPv4 and IPv6), e.g. 5000
• num-bits: integer (int64)
  Minimum Value: 0

  Maximum Value: 128

  Enter a number in the range 0..128. This will be an optional CIDR prefix for an IPv4 or IPv6 address (range: 0-32 for an IPv4 address) (range: 0-128 for an IPv6 address), e.g. 16(for IPv4) and 64(for IPv6)
• num-port-bits: integer (int64)
  Minimum Value: 0

  Maximum Value: 16

  Enter a number in the range 0..16. This will be an optional CIDR prefix for the port, (range: 0-16 for both IPv4 and IPv6), e.g. 14

{
    "required":[
        "ip-address"
    ],
    "properties":{
        "ip-address":{
            "minLength":1,
            "type":"string"
        },
        "num-bits":{
            "description":"Enter a number in the range 0..128. This will be an optional CIDR prefix for an IPv4 or IPv6 address (range: 0-32 for an IPv4 address) (range: 0-128 for an IPv6 address), e.g. 16(for IPv4) and 64(for IPv6)",
            "format":"int64",
            "maximum":128,
            "minimum":0,
            "type":"integer"
        },
        "num-port-bits":{
            "description":"Enter a number in the range 0..16. This will be an optional CIDR prefix for the port, (range: 0-16 for both IPv4 and IPv6), e.g. 14",
            "format":"int64",
            "maximum":16,
            "minimum":0,
            "type":"integer"
        },
        "ip-port":{
            "description":"Enter a number in the range 0..65535. This will be an optional port number for both IPv4 and IPv6 addresses, (range: 0-65535 for both IPv4 and IPv6), e.g. 5000",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"destination ip address",
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top