Jump to

• Request
• Response

Add a new config element: SD.sdes-profile

post

https://cloud-native-SBC-IP/config/v1/sd/sdes-profile

Add a new config element: SD.sdes-profile

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure SDES profile

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• crypto-list: array crypto-list
  list of crypto suites
• egress-offer-format: string
  Allowed Values: [ "same-as-ingress", "simultaneous-best-effort", "rfc5939-compliant" ]
• key: string
  master key (testing purpose)
• lifetime: integer (int64)
  Minimum Value: 0

  Maximum Value: 48

  lifetime value in terms of 2^ for SDES SRTP key
• mki: boolean
  enable use of master key identifier
• name(required): string
  Minimum Length: 1

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

  profile name
• options: string
  optional features/parameters
• salt: string
  master salt (testing purpose)
• srtcp-encrypt: boolean
  enable encryption of RTCP packets
• srtp-auth: boolean
  enable authentication of RTP packets
• srtp-encrypt: boolean
  enable encryption of RTP packets
• srtp-rekey-on-re-invite: boolean
  generate new outbound srtp keys on every re-invite
• use-ingress-session-params: array use-ingress-session-params
  Unique Items Required: true

  allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"profile name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "crypto-list":{
            "description":"list of crypto suites",
            "items":{
                "$ref":"#/components/schemas/SDesCryptoConstraintEnum"
            },
            "type":"array"
        },
        "srtp-auth":{
            "description":"enable authentication of RTP packets",
            "type":"boolean"
        },
        "srtp-encrypt":{
            "description":"enable encryption of RTP packets",
            "type":"boolean"
        },
        "srtcp-encrypt":{
            "description":"enable encryption of RTCP packets",
            "type":"boolean"
        },
        "mki":{
            "description":"enable use of master key identifier",
            "type":"boolean"
        },
        "egress-offer-format":{
            "$ref":"#/components/schemas/SDesEgressOfferFormatEnum"
        },
        "use-ingress-session-params":{
            "description":"allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)",
            "items":{
                "$ref":"#/components/schemas/SessParamConstraintEnum"
            },
            "type":"array",
            "uniqueItems":true
        },
        "options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "key":{
            "description":"master key (testing purpose)",
            "type":"string"
        },
        "salt":{
            "description":"master salt (testing purpose)",
            "type":"string"
        },
        "srtp-rekey-on-re-invite":{
            "description":"generate new outbound srtp keys on every re-invite",
            "type":"boolean"
        },
        "lifetime":{
            "description":"lifetime value in terms of 2^ for SDES SRTP key",
            "format":"int64",
            "maximum":48,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure SDES profile",
    "type":"object"
}

Nested Schema : crypto-list

Type: array

list of crypto suites

Show Source

• Array of: string
  Allowed Values: [ "AES_CM_128_HMAC_SHA1_80", "AES_CM_128_HMAC_SHA1_32", "AES_256_CM_HMAC_SHA1_80", "AEAD_AES_256_GCM" ]

{
    "description":"list of crypto suites",
    "items":{
        "$ref":"#/components/schemas/SDesCryptoConstraintEnum"
    },
    "type":"array"
}

Nested Schema : use-ingress-session-params

Type: array

Unique Items Required: true

allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)

Show Source

• Array of: string
  Allowed Values: [ "srtcp-encrypt", "srtp-auth", "srtp-encrypt" ]

{
    "description":"allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)",
    "items":{
        "$ref":"#/components/schemas/SessParamConstraintEnum"
    },
    "type":"array",
    "uniqueItems":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: SDesProfile

Body ()

Root Schema : schema

Type: object

configure SDES profile

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• crypto-list: array crypto-list
  list of crypto suites
• egress-offer-format: string
  Allowed Values: [ "same-as-ingress", "simultaneous-best-effort", "rfc5939-compliant" ]
• key: string
  master key (testing purpose)
• lifetime: integer (int64)
  Minimum Value: 0

  Maximum Value: 48

  lifetime value in terms of 2^ for SDES SRTP key
• mki: boolean
  enable use of master key identifier
• name(required): string
  Minimum Length: 1

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

  profile name
• options: string
  optional features/parameters
• salt: string
  master salt (testing purpose)
• srtcp-encrypt: boolean
  enable encryption of RTCP packets
• srtp-auth: boolean
  enable authentication of RTP packets
• srtp-encrypt: boolean
  enable encryption of RTP packets
• srtp-rekey-on-re-invite: boolean
  generate new outbound srtp keys on every re-invite
• use-ingress-session-params: array use-ingress-session-params
  Unique Items Required: true

  allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"profile name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "crypto-list":{
            "description":"list of crypto suites",
            "items":{
                "$ref":"#/components/schemas/SDesCryptoConstraintEnum"
            },
            "type":"array"
        },
        "srtp-auth":{
            "description":"enable authentication of RTP packets",
            "type":"boolean"
        },
        "srtp-encrypt":{
            "description":"enable encryption of RTP packets",
            "type":"boolean"
        },
        "srtcp-encrypt":{
            "description":"enable encryption of RTCP packets",
            "type":"boolean"
        },
        "mki":{
            "description":"enable use of master key identifier",
            "type":"boolean"
        },
        "egress-offer-format":{
            "$ref":"#/components/schemas/SDesEgressOfferFormatEnum"
        },
        "use-ingress-session-params":{
            "description":"allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)",
            "items":{
                "$ref":"#/components/schemas/SessParamConstraintEnum"
            },
            "type":"array",
            "uniqueItems":true
        },
        "options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "key":{
            "description":"master key (testing purpose)",
            "type":"string"
        },
        "salt":{
            "description":"master salt (testing purpose)",
            "type":"string"
        },
        "srtp-rekey-on-re-invite":{
            "description":"generate new outbound srtp keys on every re-invite",
            "type":"boolean"
        },
        "lifetime":{
            "description":"lifetime value in terms of 2^ for SDES SRTP key",
            "format":"int64",
            "maximum":48,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure SDES profile",
    "type":"object"
}

Nested Schema : crypto-list

Type: array

list of crypto suites

Show Source

• Array of: string
  Allowed Values: [ "AES_CM_128_HMAC_SHA1_80", "AES_CM_128_HMAC_SHA1_32", "AES_256_CM_HMAC_SHA1_80", "AEAD_AES_256_GCM" ]

{
    "description":"list of crypto suites",
    "items":{
        "$ref":"#/components/schemas/SDesCryptoConstraintEnum"
    },
    "type":"array"
}

Nested Schema : use-ingress-session-params

Type: array

Unique Items Required: true

allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)

Show Source

• Array of: string
  Allowed Values: [ "srtcp-encrypt", "srtp-auth", "srtp-encrypt" ]

{
    "description":"allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)",
    "items":{
        "$ref":"#/components/schemas/SessParamConstraintEnum"
    },
    "type":"array",
    "uniqueItems":true
}

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