Jump to

• Request
• Response

Retrieve one config element: SD.sti-server-group

get

https://cloud-native-SBC-IP/config/v1/sd/sti-server-group/{ElementKey}

Retrieve one config element: SD.sti-server-group

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

Body ()

Root Schema : schema

Type: object

configure high availability for STIR/SHAKEN STI servers

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• description: string
  brief description of the STI group
• name(required): string
  Minimum Length: 1

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

  STI group name
• sti-servers(required): array sti-servers
  Minimum Number of Items: 1

  list of STI servers
• strategy: string
  Allowed Values: [ "Hunt", "RoundRobin", "LeastBusy", "PropDist", "LowSusRate" ]

{
    "required":[
        "name",
        "sti-servers"
    ],
    "properties":{
        "name":{
            "description":"STI group name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"brief description of the STI group",
            "type":"string"
        },
        "strategy":{
            "$ref":"#/components/schemas/StrategySagEnum"
        },
        "sti-servers":{
            "description":"list of STI servers",
            "items":{
                "type":"string"
            },
            "minItems":1,
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure high availability for STIR/SHAKEN STI servers",
    "type":"object"
}

Nested Schema : sti-servers

Type: array

Minimum Number of Items: 1

list of STI servers

Show Source

• Array of: string

{
    "description":"list of STI servers",
    "items":{
        "type":"string"
    },
    "minItems":1,
    "type":"array"
}

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