Jump to

• Request
• Response

Retrieve the config element: SD.security-config

get

https://cloud-native-SBC-IP/config/v1/sd/security-config

Retrieve the config element: SD.security-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: SecurityConfig

Body ()

Root Schema : schema

Type: object

configure security configurations

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• image-integrity-value: string
  Message digest generated for the image
• local-cert-exp-trap-int: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  Local certificate expiration trap interval in minutes (0 disables the trap)
• local-cert-exp-warn-period: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  Local certificate expiration warning period in days
• ocsr-monitoring-traps: boolean
  Enable ocsr monitoring traps
• options: string
  Optional features/parameters
• srtp-msm-attr-name: string
  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  Media attribute name for SRTP Pass-through info
• srtp-msm-password: string srtp-msm-password
  Password to encrypt multi-system SRTP Pass-through info
• srtpMsmPasswordAsString: string

{
    "properties":{
        "ocsr-monitoring-traps":{
            "description":"Enable ocsr monitoring traps",
            "type":"boolean"
        },
        "srtp-msm-password":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SecureString"
                }
            ],
            "description":"Password to encrypt multi-system SRTP Pass-through info",
            "type":"string"
        },
        "srtp-msm-attr-name":{
            "description":"Media attribute name for SRTP Pass-through info",
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "options":{
            "description":"Optional features/parameters",
            "type":"string"
        },
        "image-integrity-value":{
            "description":"Message digest generated for the image",
            "type":"string"
        },
        "local-cert-exp-trap-int":{
            "description":"Local certificate expiration trap interval in minutes (0 disables the trap)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "local-cert-exp-warn-period":{
            "description":"Local certificate expiration warning period in days",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "srtpMsmPasswordAsString":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure security configurations",
    "type":"object"
}

Nested Schema : srtp-msm-password

Password to encrypt multi-system SRTP Pass-through info

Match All

Password to encrypt multi-system SRTP Pass-through info

Show Source

• string(password)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SecureString"
        }
    ],
    "description":"Password to encrypt multi-system SRTP Pass-through info",
    "type":"string"
}

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