Jump to

• Request
• Response

Retrieve one config element: SD.sip-nat

get

https://cloud-native-SBC-IP/config/v1/sd/sip-nat/{ElementKey}

Retrieve one config element: SD.sip-nat

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 one config element: SipNatConfig

Body ()

Root Schema : schema

Type: object

configure sip nat across realms

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• address-prefix: string
  Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])(/([0-2]?[0-9]|3[0-2]))?$|^(\*)$

  address prefix subject to SIP-NAT encoding <ipv4>[/<num-bits>] (e.g., 10.0.0.1/24) OR '*' to use the Realm's address prefix OR '0.0.0.0' to use the inverse of Home Realm's prefix
• domain-suffix(required): string
  Minimum Length: 1

  domain suffix to use in external realm (e.g., '.acme.com')
• ext-address(required): string
  Minimum Length: 1

  Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$

  external realm IPv4 address
• ext-proxy-address(required): string
  Minimum Length: 1

  Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$

  external realm proxy IPv4 address
• ext-proxy-port: integer (int32)
  Minimum Value: 1025

  Maximum Value: 65535

  external realm proxy port
• headers: array headers
  Unique Items Required: true

  list of SIP Header names to be NAT'd
• home-address(required): string
  Minimum Length: 1

  Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$

  home realm IPv4 address
• home-proxy-address: string
  Pattern: ^$|^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])$

  home realm proxy IPv4 address
• home-proxy-port: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  home realm proxy port
• host-nat-tag: string
  Pattern: ^[A-Za-z0-9-]{1,63}$

  URL host tag for NAT disambiguation. Default: ACME-
• parameter-name: string
  URL parameter name for NAT encoding
• realm-id(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  external realm identifier
• route-home-proxy: string
  Allowed Values: [ "disabled", "enabled", "forced" ]
• tunnel-redirect: boolean
  pass back Contact URIs unchanged in redirect response
• use-url-parameter: string
  Allowed Values: [ "none", "from-to", "phone", "all" ]
• user-nat-tag: string
  URL user tag for NAT disambiguation. Default: -acme-

{
    "required":[
        "realm-id",
        "domain-suffix",
        "ext-proxy-address",
        "ext-address",
        "home-address"
    ],
    "properties":{
        "realm-id":{
            "description":"external realm identifier",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "domain-suffix":{
            "description":"domain suffix to use in external realm (e.g., '.acme.com')",
            "minLength":1,
            "type":"string"
        },
        "ext-proxy-address":{
            "description":"external realm proxy IPv4 address",
            "minLength":1,
            "pattern":"$|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$",
            "type":"string"
        },
        "ext-proxy-port":{
            "description":"external realm proxy port",
            "format":"int32",
            "maximum":65535,
            "minimum":1025,
            "type":"integer"
        },
        "ext-address":{
            "description":"external realm IPv4 address",
            "minLength":1,
            "pattern":"$|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$",
            "type":"string"
        },
        "home-address":{
            "description":"home realm IPv4 address",
            "minLength":1,
            "pattern":"$|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$",
            "type":"string"
        },
        "home-proxy-address":{
            "description":"home realm proxy IPv4 address",
            "pattern":"^$|^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])$",
            "type":"string"
        },
        "home-proxy-port":{
            "description":"home realm proxy port",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "route-home-proxy":{
            "$ref":"#/components/schemas/EnForceEnum"
        },
        "address-prefix":{
            "description":"address prefix subject to SIP-NAT encoding <ipv4>[/<num-bits>] (e.g., 10.0.0.1/24) OR '*' to use the Realm's address prefix OR '0.0.0.0' to use the inverse of Home Realm's prefix",
            "pattern":"^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])(/([0-2]?[0-9]|3[0-2]))?$|^(\\*)$",
            "type":"string"
        },
        "tunnel-redirect":{
            "description":"pass back Contact URIs unchanged in redirect response",
            "type":"boolean"
        },
        "use-url-parameter":{
            "$ref":"#/components/schemas/SipNatParamEnum"
        },
        "parameter-name":{
            "description":"URL parameter name for NAT encoding",
            "type":"string"
        },
        "user-nat-tag":{
            "description":"URL user tag for NAT disambiguation. Default: -acme-",
            "type":"string"
        },
        "host-nat-tag":{
            "description":"URL host tag for NAT disambiguation. Default: ACME-",
            "pattern":"^[A-Za-z0-9-]{1,63}$",
            "type":"string"
        },
        "headers":{
            "description":"list of SIP Header names to be NAT'd",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure sip nat across realms",
    "type":"object"
}

Nested Schema : headers

Type: array

Unique Items Required: true

list of SIP Header names to be NAT'd

Show Source

• Array of: string

{
    "description":"list of SIP Header names to be NAT'd",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

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