Jump to

• Request
• Response

Retrieve the config element: SD.administrative-config

get

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

Retrieve the config element: SD.administrative-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: AdministrativeConfig

Body ()

Root Schema : schema

Type: object

Configure parameters which controls administrative flow

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• icmp-config: array icmp-config
  Control ICMP ping by setting up an ICMP config object

{
    "properties":{
        "icmp-config":{
            "description":"Control ICMP ping by setting up an ICMP config object",
            "items":{
                "$ref":"#/components/schemas/IcmpConfig"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Configure parameters which controls administrative flow",
    "type":"object"
}

Nested Schema : icmp-config

Type: array

Control ICMP ping by setting up an ICMP config object

Show Source

• Array of: object IcmpConfig
  Configure this object to enable ping on the ip's selected

{
    "description":"Control ICMP ping by setting up an ICMP config object",
    "items":{
        "$ref":"#/components/schemas/IcmpConfig"
    },
    "type":"array"
}

Nested Schema : IcmpConfig

Type: object

Configure this object to enable ping on the ip's selected

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• allowed-ip-list: array allowed-ip-list
  Add IPs to enable ping, Must be within the service network CIDR range
• ping-ephemeral-ips: boolean
  When enabled, this allows ping on all ephemeral IPs in associated CIDR range and removes the need to manually include them in the allowed-ip-list
• service-network-id(required): string
  Minimum Length: 1

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

  Service network identifier for the associated IP address pool

{
    "required":[
        "service-network-id"
    ],
    "properties":{
        "allowed-ip-list":{
            "description":"Add IPs to enable ping, Must be within the service network CIDR range",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "ping-ephemeral-ips":{
            "description":"When enabled, this allows ping on all ephemeral IPs in associated CIDR range and removes the need to manually include them in the allowed-ip-list",
            "type":"boolean"
        },
        "service-network-id":{
            "description":"Service network identifier for the associated IP address pool",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Configure this object to enable ping on the ip's selected",
    "type":"object"
}

Nested Schema : allowed-ip-list

Type: array

Add IPs to enable ping, Must be within the service network CIDR range

Show Source

• Array of: string

{
    "description":"Add IPs to enable ping, Must be within the service network CIDR range",
    "items":{
        "type":"string"
    },
    "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