Jump to

• Request
• Response

Retrieve the config element: SD.sti-heartbeat-config

get

https://cloud-native-SBC-IP/config/v1/sd/sti-heartbeat-config

Retrieve the config element: SD.sti-heartbeat-config

Request

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 config element: StiHeartbeatConfig

Body ()

Root Schema : schema

Type: object

configure global parameters for STIR/SHAKEN heartbeat message

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• sti-dest-tn-number: string
  This number is used as called party TN number to send the STIR request
• sti-div-tn-number: string
  This number is used as called party div TN number to send the STIR request
• sti-heartbeat-msg-interval-time: integer (int32)
  Minimum Value: 1

  Maximum Value: 3600

  Heartbeat message interval time in seconds for sending a dummy request during the open/half-open state of the circuit breaker.
• sti-heartbeat-state: boolean
  If enabled, the cnSBC performs Heartbeat (Ping) functionality to all STIR servers, except those with the sti-heartbeat-state flag disabled.
• sti-orig-tn-number: string
  This number is used as calling party number to send the STIR request

{
    "properties":{
        "sti-heartbeat-state":{
            "description":"If enabled, the cnSBC performs Heartbeat (Ping) functionality to all STIR servers, except those with the sti-heartbeat-state flag disabled.",
            "type":"boolean"
        },
        "sti-heartbeat-msg-interval-time":{
            "description":"Heartbeat message interval time in seconds for sending a dummy request during the open/half-open state of the circuit breaker.",
            "format":"int32",
            "maximum":3600,
            "minimum":1,
            "type":"integer"
        },
        "sti-orig-tn-number":{
            "description":"This number is used as calling party number to send the STIR request",
            "type":"string"
        },
        "sti-dest-tn-number":{
            "description":"This number is used as called party TN number to send the STIR request",
            "type":"string"
        },
        "sti-div-tn-number":{
            "description":"This number is used as called party div TN number to send the STIR request",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure global parameters for STIR/SHAKEN heartbeat message",
    "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