Jump to

• Request
• Response

Retrieve all config elements: SD.rtcp-policy

get

https://cloud-native-SBC-IP/config/v1/sd/rtcp-policy

Retrieve all config elements: SD.rtcp-policy

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 all config elements: RtcpPolicy

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema
  configure rtcp policy

{
    "items":{
        "$ref":"#/components/schemas/RtcpPolicy"
    },
    "type":"array"
}

Nested Schema : schema

Type: object

configure rtcp policy

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• hide-cname: boolean
  Enabling will hide IP address and UDP port from CNAME field in RTCP reports
• name(required): string
  Minimum Length: 1

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

  rtcp policy name
• rtcp-generate: string
  Allowed Values: [ "none", "xcoded-calls-only", "all-calls" ]

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"rtcp policy name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "rtcp-generate":{
            "$ref":"#/components/schemas/RtcpGenerationModeEnum"
        },
        "hide-cname":{
            "description":"Enabling will hide IP address and UDP port from CNAME field in RTCP reports",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure rtcp policy",
    "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