Jump to

• Request
• Response

Replace a config element: SD.media-policy

put

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

Replace a config element: SD.media-policy

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure a media profile and apply it to a realm

Show Source

• _elementKey: string
  Read Only: true

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

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

  media policy name
• rtp-ttl: integer (int32)
  Minimum Value: 0

  Maximum Value: 255

  RTP Time To Live (TTL)
• tos-settings: array tos-settings
  list of tos settings

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"media policy name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "tos-settings":{
            "description":"list of tos settings",
            "items":{
                "$ref":"#/components/schemas/TosSetting"
            },
            "type":"array"
        },
        "rtp-ttl":{
            "description":"RTP Time To Live (TTL)",
            "format":"int32",
            "maximum":255,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure a media profile and apply it to a realm",
    "type":"object"
}

Nested Schema : tos-settings

Type: array

list of tos settings

Show Source

• Array of: object TosSetting
  list of tos settings

{
    "description":"list of tos settings",
    "items":{
        "$ref":"#/components/schemas/TosSetting"
    },
    "type":"array"
}

Nested Schema : TosSetting

Type: object

list of tos settings

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• media-attributes: array media-attributes
  media attribute to match within SDP
• media-sub-type: string
  media sub-type to match against. If no value is entered, a wildcard is used
• media-type(required): string
  Minimum Length: 1

  media type to match against for e.g. application|audio|image|message|text|video
• tos-value: string
  a decimal or hex number

{
    "required":[
        "media-type"
    ],
    "properties":{
        "media-type":{
            "description":"media type to match against for e.g. application|audio|image|message|text|video",
            "minLength":1,
            "type":"string"
        },
        "media-sub-type":{
            "description":"media sub-type to match against. If no value is entered, a wildcard is used",
            "type":"string"
        },
        "tos-value":{
            "description":"a decimal or hex number",
            "type":"string"
        },
        "media-attributes":{
            "description":"media attribute to match within SDP",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of tos settings",
    "type":"object"
}

Nested Schema : media-attributes

Type: array

media attribute to match within SDP

Show Source

• Array of: string

{
    "description":"media attribute to match within SDP",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: MediaPolicy

Body ()

Root Schema : schema

Type: object

configure a media profile and apply it to a realm

Show Source

• _elementKey: string
  Read Only: true

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

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

  media policy name
• rtp-ttl: integer (int32)
  Minimum Value: 0

  Maximum Value: 255

  RTP Time To Live (TTL)
• tos-settings: array tos-settings
  list of tos settings

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"media policy name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "tos-settings":{
            "description":"list of tos settings",
            "items":{
                "$ref":"#/components/schemas/TosSetting"
            },
            "type":"array"
        },
        "rtp-ttl":{
            "description":"RTP Time To Live (TTL)",
            "format":"int32",
            "maximum":255,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure a media profile and apply it to a realm",
    "type":"object"
}

Nested Schema : tos-settings

Type: array

list of tos settings

Show Source

• Array of: object TosSetting
  list of tos settings

{
    "description":"list of tos settings",
    "items":{
        "$ref":"#/components/schemas/TosSetting"
    },
    "type":"array"
}

Nested Schema : TosSetting

Type: object

list of tos settings

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• media-attributes: array media-attributes
  media attribute to match within SDP
• media-sub-type: string
  media sub-type to match against. If no value is entered, a wildcard is used
• media-type(required): string
  Minimum Length: 1

  media type to match against for e.g. application|audio|image|message|text|video
• tos-value: string
  a decimal or hex number

{
    "required":[
        "media-type"
    ],
    "properties":{
        "media-type":{
            "description":"media type to match against for e.g. application|audio|image|message|text|video",
            "minLength":1,
            "type":"string"
        },
        "media-sub-type":{
            "description":"media sub-type to match against. If no value is entered, a wildcard is used",
            "type":"string"
        },
        "tos-value":{
            "description":"a decimal or hex number",
            "type":"string"
        },
        "media-attributes":{
            "description":"media attribute to match within SDP",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of tos settings",
    "type":"object"
}

Nested Schema : media-attributes

Type: array

media attribute to match within SDP

Show Source

• Array of: string

{
    "description":"media attribute to match within SDP",
    "items":{
        "type":"string"
    },
    "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"
}

406 Response

Validation Failure

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