Jump to

• Request
• Response

Retrieve one config element: SD.tls-profile

get

https://cloud-native-SBC-IP/config/v1/sd/tls-profile/{ElementKey}

Retrieve one config element: SD.tls-profile

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

Body ()

Root Schema : schema

Type: object

configure the parameters for running SIP over TLS

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• allow-self-signed-cert: boolean
  Allow self-signed certificate for MSRP
• cert-status-check: boolean
  cert-status check state
• cipher-list(required): array cipher-list
  Minimum Number of Items: 1

  list of ciphers
• end-entity-certificate: string
  end entity certificate for the TLS connection
• ignore-dead-responder: boolean
  Ignore dead cert-status responder
• mutual-authenticate: boolean
  Mutually authenticate
• name(required): string
  Minimum Length: 1

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

  Name for the TLS-profile
• options: string
  Optional features/parameters
• trusted-ca-certificates: array trusted-ca-certificates
  list of trusted certificate records
• verify-depth: integer (int64)
  Minimum Value: 0

  Maximum Value: 10

  Verify Depth for mutual authentication
• version-list(required): array version-list
  Minimum Number of Items: 1

  list of TLS version

{
    "required":[
        "name",
        "cipher-list",
        "version-list"
    ],
    "properties":{
        "name":{
            "description":"Name for the TLS-profile",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "end-entity-certificate":{
            "description":"end entity certificate for the TLS connection",
            "type":"string"
        },
        "trusted-ca-certificates":{
            "description":"list of trusted certificate records",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "cipher-list":{
            "description":"list of ciphers",
            "items":{
                "$ref":"#/components/schemas/TLSCipherConstraintEnum"
            },
            "minItems":1,
            "type":"array"
        },
        "verify-depth":{
            "description":"Verify Depth for mutual authentication",
            "format":"int64",
            "maximum":10,
            "minimum":0,
            "type":"integer"
        },
        "mutual-authenticate":{
            "description":"Mutually authenticate",
            "type":"boolean"
        },
        "version-list":{
            "description":"list of TLS version",
            "items":{
                "$ref":"#/components/schemas/TlsVersionsEnum"
            },
            "minItems":1,
            "type":"array"
        },
        "options":{
            "description":"Optional features/parameters",
            "type":"string"
        },
        "cert-status-check":{
            "description":"cert-status check state",
            "type":"boolean"
        },
        "ignore-dead-responder":{
            "description":"Ignore dead cert-status responder",
            "type":"boolean"
        },
        "allow-self-signed-cert":{
            "description":"Allow self-signed certificate for MSRP",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure the parameters for running SIP over TLS",
    "type":"object"
}

Nested Schema : cipher-list

Type: array

Minimum Number of Items: 1

list of ciphers

Show Source

• Array of: string
  Allowed Values: [ "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_AES_128_GCM_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_CHACHA20_POLY1305_SHA256", "DEFAULT", "NONE" ]

{
    "description":"list of ciphers",
    "items":{
        "$ref":"#/components/schemas/TLSCipherConstraintEnum"
    },
    "minItems":1,
    "type":"array"
}

Nested Schema : trusted-ca-certificates

Type: array

list of trusted certificate records

Show Source

• Array of: string

{
    "description":"list of trusted certificate records",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : version-list

Type: array

Minimum Number of Items: 1

list of TLS version

Show Source

• Array of: string
  Allowed Values: [ "tlsv12", "tlsv13" ]

{
    "description":"list of TLS version",
    "items":{
        "$ref":"#/components/schemas/TlsVersionsEnum"
    },
    "minItems":1,
    "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"
}

Back to Top