Jump to

• Request
• Response

Retrieve all config elements: SD.sip-feature

get

https://cloud-native-SBC-IP/config/v1/sd/sip-feature

Retrieve all config elements: SD.sip-feature

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 all config elements: SipFeature

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema
  configure SIP option tag parameters

{
    "items":{
        "$ref":"#/components/schemas/SipFeature"
    },
    "type":"array"
}

Nested Schema : schema

Type: object

configure SIP option tag parameters

Show Source

• _elementKey: string
  Read Only: true

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

  SIP feature tag name
• proxy-require-mode-inbound: string
  Allowed Values: [ "Pass", "Reject" ]
• proxy-require-mode-outbound: string
  Allowed Values: [ "Pass", "Reject" ]
• realm: string
  Realm name with which the feature will be associated. To make it a global feature leave this parameter blank
• require-mode-inbound: string
  Allowed Values: [ "Pass", "Reject" ]
• require-mode-outbound: string
  Allowed Values: [ "Pass", "Reject" ]
• support-mode-inbound: string
  Allowed Values: [ "Pass", "Strip" ]
• support-mode-outbound: string
  Allowed Values: [ "Pass", "Strip" ]

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"SIP feature tag name",
            "minLength":1,
            "type":"string"
        },
        "realm":{
            "description":"Realm name with which the feature will be associated. To make it a global feature leave this parameter blank",
            "type":"string"
        },
        "support-mode-inbound":{
            "$ref":"#/components/schemas/SipSupportModeEnum"
        },
        "require-mode-inbound":{
            "$ref":"#/components/schemas/SipRequireModeEnum"
        },
        "proxy-require-mode-inbound":{
            "$ref":"#/components/schemas/SipRequireModeEnum"
        },
        "support-mode-outbound":{
            "$ref":"#/components/schemas/SipSupportModeEnum"
        },
        "require-mode-outbound":{
            "$ref":"#/components/schemas/SipRequireModeEnum"
        },
        "proxy-require-mode-outbound":{
            "$ref":"#/components/schemas/SipRequireModeEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure SIP option tag parameters",
    "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