Jump to

• Request
• Response

Replace a config element: SD.steering-pool

put

https://cloud-native-SBC-IP/config/v1/sd/steering-pool/{ElementKey}

Replace a config element: SD.steering-pool

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

specify one or more ports for steering media flows

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• end-port: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  end port
• realm-id(required): string
  Minimum Length: 1

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

  name of realm this pool is used for
• start-port(required): integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  start port
• steering-pool-ip-list-id(required): string
  Minimum Length: 1

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

  Name of steering pool IP list

{
    "required":[
        "steering-pool-ip-list-id",
        "start-port",
        "realm-id"
    ],
    "properties":{
        "steering-pool-ip-list-id":{
            "description":"Name of steering pool IP list",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "start-port":{
            "description":"start port",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "end-port":{
            "description":"end port",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "realm-id":{
            "description":"name of realm this pool is used for",
            "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":"specify one or more ports for steering media flows",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: SteeringPool

Body ()

Root Schema : schema

Type: object

specify one or more ports for steering media flows

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• end-port: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  end port
• realm-id(required): string
  Minimum Length: 1

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

  name of realm this pool is used for
• start-port(required): integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  start port
• steering-pool-ip-list-id(required): string
  Minimum Length: 1

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

  Name of steering pool IP list

{
    "required":[
        "steering-pool-ip-list-id",
        "start-port",
        "realm-id"
    ],
    "properties":{
        "steering-pool-ip-list-id":{
            "description":"Name of steering pool IP list",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "start-port":{
            "description":"start port",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "end-port":{
            "description":"end port",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "realm-id":{
            "description":"name of realm this pool is used for",
            "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":"specify one or more ports for steering media flows",
    "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"
}

406 Response

Validation Failure

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