Jump to

• Request
• Response

Replace a config element: SD.allowed-elements-profile

put

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

Replace a config element: SD.allowed-elements-profile

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure allowed elements profiles

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• allow-any: array allow-any
  Unique Items Required: true

  set of default headers
• description: string
  description for the allowed-elements-profile
• name(required): string
  Minimum Length: 1

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

  unique identifier of the allowed-elements-profile
• rule-sets: array rule-sets
  Unique Items Required: true

  list of rule-sets

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"unique identifier of the allowed-elements-profile",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"description for the allowed-elements-profile",
            "type":"string"
        },
        "rule-sets":{
            "description":"list of rule-sets",
            "items":{
                "$ref":"#/components/schemas/WLRuleSetConfig"
            },
            "type":"array",
            "uniqueItems":true
        },
        "allow-any":{
            "description":"set of default headers",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure allowed elements profiles",
    "type":"object"
}

Nested Schema : allow-any

Type: array

Unique Items Required: true

set of default headers

Show Source

• Array of: string

{
    "description":"set of default headers",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : rule-sets

Type: array

Unique Items Required: true

list of rule-sets

Show Source

• Array of: object WLRuleSetConfig
  list of rule-sets

{
    "description":"list of rule-sets",
    "items":{
        "$ref":"#/components/schemas/WLRuleSetConfig"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : WLRuleSetConfig

Type: object

list of rule-sets

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• header-rules: array header-rules
  list of header-rules
• logging: boolean
  enable logging of messages when unmatched element exists
• methods: array methods
  Unique Items Required: true

  specifies list of methods to which the rule applies (applies to all methods when none are specified)
• msg-type: string
  Allowed Values: [ "any", "request", "response" ]
• name(required): string
  Minimum Length: 1

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

  unique identifier of the rule-set
• unmatched-action: string
  Allowed Values: [ "reject", "delete" ]

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"unique identifier of the rule-set",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "unmatched-action":{
            "$ref":"#/components/schemas/AllowListUnmatchedActionEnum"
        },
        "msg-type":{
            "$ref":"#/components/schemas/AllowListMsgTypeEnum"
        },
        "methods":{
            "description":"specifies list of methods to which the rule applies (applies to all methods when none are specified)",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "logging":{
            "description":"enable logging of messages when unmatched element exists",
            "type":"boolean"
        },
        "header-rules":{
            "description":"list of header-rules",
            "items":{
                "$ref":"#/components/schemas/WLHeaderRuleConfig"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of rule-sets",
    "type":"object"
}

Nested Schema : header-rules

Type: array

list of header-rules

Show Source

• Array of: object WLHeaderRuleConfig
  list of header-rules

{
    "description":"list of header-rules",
    "items":{
        "$ref":"#/components/schemas/WLHeaderRuleConfig"
    },
    "type":"array"
}

Nested Schema : methods

Type: array

Unique Items Required: true

specifies list of methods to which the rule applies (applies to all methods when none are specified)

Show Source

• Array of: string

{
    "description":"specifies list of methods to which the rule applies (applies to all methods when none are specified)",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : WLHeaderRuleConfig

Type: object

list of header-rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• allow-header-param: array allow-header-param
  Unique Items Required: true

  the list of header parameters which are allowed, where * implies all are allowed
• allow-uri-header-name: array allow-uri-header-name
  Unique Items Required: true

  the list of URI header names which are allowed, where * implies all are allowed
• allow-uri-param: array allow-uri-param
  Unique Items Required: true

  the list of URI parameters which are allowed, where * implies all are allowed
• allow-uri-user-param: array allow-uri-user-param
  Unique Items Required: true

  the list of URI user parameters which are allowed, where * implies all are allowed
• header-name(required): string
  Minimum Length: 1

  name of the allowed header. To change the request line of a request, use the header name request-uri. To apply the rule to all unmatched headers, use the header name *
• unmatched-action: string
  Allowed Values: [ "reject", "delete" ]

{
    "required":[
        "header-name"
    ],
    "properties":{
        "header-name":{
            "description":"name of the allowed header. To change the request line of a request, use the header name request-uri. To apply the rule to all unmatched headers, use the header name *",
            "minLength":1,
            "type":"string"
        },
        "unmatched-action":{
            "$ref":"#/components/schemas/AllowListUnmatchedActionEnum"
        },
        "allow-header-param":{
            "description":"the list of header parameters which are allowed, where * implies all are allowed",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "allow-uri-param":{
            "description":"the list of URI parameters which are allowed, where * implies all are allowed",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "allow-uri-user-param":{
            "description":"the list of URI user parameters which are allowed, where * implies all are allowed",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "allow-uri-header-name":{
            "description":"the list of URI header names which are allowed, where * implies all are allowed",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of header-rules",
    "type":"object"
}

Nested Schema : allow-header-param

Type: array

Unique Items Required: true

the list of header parameters which are allowed, where * implies all are allowed

Show Source

• Array of: string

{
    "description":"the list of header parameters which are allowed, where * implies all are allowed",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : allow-uri-header-name

Type: array

Unique Items Required: true

the list of URI header names which are allowed, where * implies all are allowed

Show Source

• Array of: string

{
    "description":"the list of URI header names which are allowed, where * implies all are allowed",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : allow-uri-param

Type: array

Unique Items Required: true

the list of URI parameters which are allowed, where * implies all are allowed

Show Source

• Array of: string

{
    "description":"the list of URI parameters which are allowed, where * implies all are allowed",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : allow-uri-user-param

Type: array

Unique Items Required: true

the list of URI user parameters which are allowed, where * implies all are allowed

Show Source

• Array of: string

{
    "description":"the list of URI user parameters which are allowed, where * implies all are allowed",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: AllowlistConfig

Body ()

Root Schema : schema

Type: object

configure allowed elements profiles

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• allow-any: array allow-any
  Unique Items Required: true

  set of default headers
• description: string
  description for the allowed-elements-profile
• name(required): string
  Minimum Length: 1

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

  unique identifier of the allowed-elements-profile
• rule-sets: array rule-sets
  Unique Items Required: true

  list of rule-sets

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"unique identifier of the allowed-elements-profile",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"description for the allowed-elements-profile",
            "type":"string"
        },
        "rule-sets":{
            "description":"list of rule-sets",
            "items":{
                "$ref":"#/components/schemas/WLRuleSetConfig"
            },
            "type":"array",
            "uniqueItems":true
        },
        "allow-any":{
            "description":"set of default headers",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure allowed elements profiles",
    "type":"object"
}

Nested Schema : allow-any

Type: array

Unique Items Required: true

set of default headers

Show Source

• Array of: string

{
    "description":"set of default headers",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : rule-sets

Type: array

Unique Items Required: true

list of rule-sets

Show Source

• Array of: object WLRuleSetConfig
  list of rule-sets

{
    "description":"list of rule-sets",
    "items":{
        "$ref":"#/components/schemas/WLRuleSetConfig"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : WLRuleSetConfig

Type: object

list of rule-sets

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• header-rules: array header-rules
  list of header-rules
• logging: boolean
  enable logging of messages when unmatched element exists
• methods: array methods
  Unique Items Required: true

  specifies list of methods to which the rule applies (applies to all methods when none are specified)
• msg-type: string
  Allowed Values: [ "any", "request", "response" ]
• name(required): string
  Minimum Length: 1

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

  unique identifier of the rule-set
• unmatched-action: string
  Allowed Values: [ "reject", "delete" ]

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"unique identifier of the rule-set",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "unmatched-action":{
            "$ref":"#/components/schemas/AllowListUnmatchedActionEnum"
        },
        "msg-type":{
            "$ref":"#/components/schemas/AllowListMsgTypeEnum"
        },
        "methods":{
            "description":"specifies list of methods to which the rule applies (applies to all methods when none are specified)",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "logging":{
            "description":"enable logging of messages when unmatched element exists",
            "type":"boolean"
        },
        "header-rules":{
            "description":"list of header-rules",
            "items":{
                "$ref":"#/components/schemas/WLHeaderRuleConfig"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of rule-sets",
    "type":"object"
}

Nested Schema : header-rules

Type: array

list of header-rules

Show Source

• Array of: object WLHeaderRuleConfig
  list of header-rules

{
    "description":"list of header-rules",
    "items":{
        "$ref":"#/components/schemas/WLHeaderRuleConfig"
    },
    "type":"array"
}

Nested Schema : methods

Type: array

Unique Items Required: true

specifies list of methods to which the rule applies (applies to all methods when none are specified)

Show Source

• Array of: string

{
    "description":"specifies list of methods to which the rule applies (applies to all methods when none are specified)",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : WLHeaderRuleConfig

Type: object

list of header-rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• allow-header-param: array allow-header-param
  Unique Items Required: true

  the list of header parameters which are allowed, where * implies all are allowed
• allow-uri-header-name: array allow-uri-header-name
  Unique Items Required: true

  the list of URI header names which are allowed, where * implies all are allowed
• allow-uri-param: array allow-uri-param
  Unique Items Required: true

  the list of URI parameters which are allowed, where * implies all are allowed
• allow-uri-user-param: array allow-uri-user-param
  Unique Items Required: true

  the list of URI user parameters which are allowed, where * implies all are allowed
• header-name(required): string
  Minimum Length: 1

  name of the allowed header. To change the request line of a request, use the header name request-uri. To apply the rule to all unmatched headers, use the header name *
• unmatched-action: string
  Allowed Values: [ "reject", "delete" ]

{
    "required":[
        "header-name"
    ],
    "properties":{
        "header-name":{
            "description":"name of the allowed header. To change the request line of a request, use the header name request-uri. To apply the rule to all unmatched headers, use the header name *",
            "minLength":1,
            "type":"string"
        },
        "unmatched-action":{
            "$ref":"#/components/schemas/AllowListUnmatchedActionEnum"
        },
        "allow-header-param":{
            "description":"the list of header parameters which are allowed, where * implies all are allowed",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "allow-uri-param":{
            "description":"the list of URI parameters which are allowed, where * implies all are allowed",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "allow-uri-user-param":{
            "description":"the list of URI user parameters which are allowed, where * implies all are allowed",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "allow-uri-header-name":{
            "description":"the list of URI header names which are allowed, where * implies all are allowed",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of header-rules",
    "type":"object"
}

Nested Schema : allow-header-param

Type: array

Unique Items Required: true

the list of header parameters which are allowed, where * implies all are allowed

Show Source

• Array of: string

{
    "description":"the list of header parameters which are allowed, where * implies all are allowed",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : allow-uri-header-name

Type: array

Unique Items Required: true

the list of URI header names which are allowed, where * implies all are allowed

Show Source

• Array of: string

{
    "description":"the list of URI header names which are allowed, where * implies all are allowed",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : allow-uri-param

Type: array

Unique Items Required: true

the list of URI parameters which are allowed, where * implies all are allowed

Show Source

• Array of: string

{
    "description":"the list of URI parameters which are allowed, where * implies all are allowed",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : allow-uri-user-param

Type: array

Unique Items Required: true

the list of URI user parameters which are allowed, where * implies all are allowed

Show Source

• Array of: string

{
    "description":"the list of URI user parameters which are allowed, where * implies all are allowed",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

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