Jump to

• Request
• Response

Replace a config element: SD.local-routing-config

put

https://cloud-native-SBC-IP/config/v1/sd/local-routing-config/{ElementKey}

Replace a config element: SD.local-routing-config

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure local routing servers

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• file-name(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$|^[^/]+((.gz)|(.gzip))$

  XML file containing the routing entries to be used for this local-route server
• match-mode: string
  Allowed Values: [ "exact", "best", "all" ]
• name(required): string
  Minimum Length: 1

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

  Name of the local-routing routing server
• prefix-length: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  Number of digits/characters to be used for local route matching
• retarget-requests: boolean
  Replace Request-URI in forwarded requests
• string-lookup: boolean
  Use string lookups instead of E.164 phone number. Enable for tables with range entries that have alphanumeric prefixes

{
    "required":[
        "name",
        "file-name"
    ],
    "properties":{
        "name":{
            "description":"Name of the local-routing routing server",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "file-name":{
            "description":"XML file containing the routing entries to be used for this local-route server",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$|^[^/]+((.gz)|(.gzip))$",
            "type":"string"
        },
        "prefix-length":{
            "description":"Number of digits/characters to be used for local route matching",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "string-lookup":{
            "description":"Use string lookups instead of E.164 phone number. Enable for tables with range entries that have alphanumeric prefixes",
            "type":"boolean"
        },
        "retarget-requests":{
            "description":"Replace Request-URI in forwarded requests",
            "type":"boolean"
        },
        "match-mode":{
            "$ref":"#/components/schemas/LrtMatchEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure local routing servers",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: LocalRoutingConfig

Body ()

Root Schema : schema

Type: object

configure local routing servers

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• file-name(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$|^[^/]+((.gz)|(.gzip))$

  XML file containing the routing entries to be used for this local-route server
• match-mode: string
  Allowed Values: [ "exact", "best", "all" ]
• name(required): string
  Minimum Length: 1

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

  Name of the local-routing routing server
• prefix-length: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  Number of digits/characters to be used for local route matching
• retarget-requests: boolean
  Replace Request-URI in forwarded requests
• string-lookup: boolean
  Use string lookups instead of E.164 phone number. Enable for tables with range entries that have alphanumeric prefixes

{
    "required":[
        "name",
        "file-name"
    ],
    "properties":{
        "name":{
            "description":"Name of the local-routing routing server",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "file-name":{
            "description":"XML file containing the routing entries to be used for this local-route server",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$|^[^/]+((.gz)|(.gzip))$",
            "type":"string"
        },
        "prefix-length":{
            "description":"Number of digits/characters to be used for local route matching",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "string-lookup":{
            "description":"Use string lookups instead of E.164 phone number. Enable for tables with range entries that have alphanumeric prefixes",
            "type":"boolean"
        },
        "retarget-requests":{
            "description":"Replace Request-URI in forwarded requests",
            "type":"boolean"
        },
        "match-mode":{
            "$ref":"#/components/schemas/LrtMatchEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure local routing servers",
    "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"
}

406 Response

Validation Failure

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