Jump to

• Request
• Response

Retrieve one config element: SD.media-sec-policy

get

https://cloud-native-SBC-IP/config/v1/sd/media-sec-policy/{ElementKey}

Retrieve one config element: SD.media-sec-policy

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

Body ()

Root Schema : schema

Type: object

configure media security policy

Show Source

• _elementKey: string
  Read Only: true

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

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

  name
• options: string
  optional features/parameters
• outbound: object MediaSecProfileOutbound
  outbound
• pass-through: boolean
  pass-through

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "pass-through":{
            "description":"pass-through",
            "type":"boolean"
        },
        "options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "inbound":{
            "$ref":"#/components/schemas/MediaSecProfileInbound"
        },
        "outbound":{
            "$ref":"#/components/schemas/MediaSecProfileOutbound"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure media security policy",
    "type":"object"
}

Nested Schema : MediaSecProfileInbound

Type: object

inbound

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• hide-egress-media-update: boolean
  hide changes to ingress RTP egressing into realm
• mode: string
  Allowed Values: [ "rtp", "srtp", "any" ]
• profile: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$

  profile name
• protocol: string
  Allowed Values: [ "none", "sipura", "sdes" ]

{
    "properties":{
        "profile":{
            "description":"profile name",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$",
            "type":"string"
        },
        "mode":{
            "$ref":"#/components/schemas/MediaSecProfileModeConstraintEnum"
        },
        "protocol":{
            "$ref":"#/components/schemas/MediaSecProfileProtocolConstraintEnum"
        },
        "hide-egress-media-update":{
            "description":"hide changes to ingress RTP egressing into realm",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"inbound",
    "type":"object"
}

Nested Schema : MediaSecProfileOutbound

Type: object

outbound

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• mode: string
  Allowed Values: [ "rtp", "srtp", "any" ]
• profile: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$

  profile name
• protocol: string
  Allowed Values: [ "none", "sipura", "sdes" ]

{
    "properties":{
        "profile":{
            "description":"profile name",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$",
            "type":"string"
        },
        "mode":{
            "$ref":"#/components/schemas/MediaSecProfileModeConstraintEnum"
        },
        "protocol":{
            "$ref":"#/components/schemas/MediaSecProfileProtocolConstraintEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"outbound",
    "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