Jump to

• Request
• Response

Retrieve all sub-elements: SD.spl-config.plugins

get

https://cloud-native-SBC-IP/config/v1/sd/spl-config/plugins

Retrieve all sub-elements: SD.spl-config.plugins

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 sub elements: SplPluginConfig

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema
  list of spl plugins

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

Nested Schema : schema

Type: object

list of spl plugins

Show Source

• _elementKey: string
  Read Only: true

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

  name of the spl plugin/package to load
• state: boolean
  state

{
    "required":[
        "name"
    ],
    "properties":{
        "state":{
            "description":"state",
            "type":"boolean"
        },
        "name":{
            "description":"name of the spl plugin/package to load",
            "minLength":1,
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of spl plugins",
    "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