Jump to

• Request
• Response

Retrieve one config element: SD.enum-config

get

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

Retrieve one config element: SD.enum-config

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

Body ()

Root Schema : schema

Type: object

configure enum servers

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• cache-addl-records: boolean
  Cache/use additional DNS records included in received Enum (NAPTR) Responses
• cacheInactivityTimer: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  Timer interval after which an inactive cache entry is removed (seconds)
• enum-servers: array enum-servers
  List of ENUM servers where the first server is the primary, and the rest serve as backups
• failover-to: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  Name of the enum-config to failover to
• health-query-interval: integer (int64)
  Minimum Value: 0

  Maximum Value: 65535

  Health query interval (seconds). 0 means health query is disabled
• health-query-number: string
  Pattern: ^$|^((\+[0-9.()-]+)|([0-9A-F*#.()-]+))(;.*)?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  Health query phone number. e.g., [phone]
• include-source-info: boolean
  Include source information in queries
• lookup-length: integer (int64)
  Minimum Value: 0

  Maximum Value: 255

  Specifies the length of the ENUM query starting from the most significant bit
• max-response-size: integer (int64)
  Minimum Value: 512

  Maximum Value: 65535

  Specifies EDNS0 capability for UDP ENUM responses larger than 512 bytes
• name(required): string
  Minimum Length: 1

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

  Enum Config name
• options: string
  Optional features/parameters
• query-method: string
  Allowed Values: [ "hunt", "round-robin" ]
• realm-id: string
  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  Realm in which these enum servers are located
• recursive-query: boolean
  Do recursive query if NS record in answer
• remote-recursion: boolean
  Set RD bit for remote (server) to query recursively
• retarget-requests: boolean
  Replace Request-URI in forwarded requests
• service-type: string
  Pattern: ^((E2U\+([A-Za-z0-9:+]){1,32})|(([A-Za-z0-9:]){1,32}\+E2U))?(,((E2U\+([A-Za-z0-9:+]){1,32})|(([A-Za-z0-9:+]{1,32})\+E2U)))*$

  List of Enum Service Types. e.g., E2U+sip,sip+E2U,E2U+tel
• timeout: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  Maximum waiting time for a Enum response (seconds)
• top-level-domain: 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-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([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-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([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-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([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-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([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-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([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-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([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-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([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-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$

  Top Level Domain to be used for queries using this enum configuration

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Enum Config name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "top-level-domain":{
            "description":"Top Level Domain to be used for queries using this enum configuration",
            "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-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([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-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([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-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([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-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([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-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([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-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([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-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([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-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$",
            "type":"string"
        },
        "realm-id":{
            "description":"Realm in which these enum servers are located",
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "enum-servers":{
            "description":"List of ENUM servers where the first server is the primary, and the rest serve as backups",
            "items":{
                "$ref":"#/components/schemas/EnumServer"
            },
            "type":"array"
        },
        "service-type":{
            "description":"List of Enum Service Types. e.g., E2U+sip,sip+E2U,E2U+tel",
            "pattern":"^((E2U\\+([A-Za-z0-9:+]){1,32})|(([A-Za-z0-9:]){1,32}\\+E2U))?(,((E2U\\+([A-Za-z0-9:+]){1,32})|(([A-Za-z0-9:+]{1,32})\\+E2U)))*$",
            "type":"string"
        },
        "query-method":{
            "$ref":"#/components/schemas/DnsQueryMethodEnum"
        },
        "timeout":{
            "description":"Maximum waiting time for a Enum response (seconds)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "cacheInactivityTimer":{
            "description":"Timer interval after which an inactive cache entry is removed (seconds)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "lookup-length":{
            "description":"Specifies the length of the ENUM query starting from the most significant bit",
            "format":"int64",
            "maximum":255,
            "minimum":0,
            "type":"integer"
        },
        "max-response-size":{
            "description":"Specifies EDNS0 capability for UDP ENUM responses larger than 512 bytes",
            "format":"int64",
            "maximum":65535,
            "minimum":512,
            "type":"integer"
        },
        "remote-recursion":{
            "description":"Set RD bit for remote (server) to query recursively",
            "type":"boolean"
        },
        "health-query-number":{
            "description":"Health query phone number. e.g., [phone]",
            "pattern":"^$|^((\\+[0-9.()-]+)|([0-9A-F*#.()-]+))(;.*)?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "health-query-interval":{
            "description":"Health query interval (seconds). 0 means health query is disabled",
            "format":"int64",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "failover-to":{
            "description":"Name of the enum-config to failover to",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "cache-addl-records":{
            "description":"Cache/use additional DNS records included in received Enum (NAPTR) Responses",
            "type":"boolean"
        },
        "include-source-info":{
            "description":"Include source information in queries",
            "type":"boolean"
        },
        "retarget-requests":{
            "description":"Replace Request-URI in forwarded requests",
            "type":"boolean"
        },
        "recursive-query":{
            "description":"Do recursive query if NS record in answer",
            "type":"boolean"
        },
        "options":{
            "description":"Optional features/parameters",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure enum servers",
    "type":"object"
}

Nested Schema : enum-servers

Type: array

List of ENUM servers where the first server is the primary, and the rest serve as backups

Show Source

• Array of: object EnumServer

{
    "description":"List of ENUM servers where the first server is the primary, and the rest serve as backups",
    "items":{
        "$ref":"#/components/schemas/EnumServer"
    },
    "type":"array"
}

Nested Schema : EnumServer

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• addr: string

{
    "properties":{
        "addr":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "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