Jump to

• Request
• Response
• Examples

Delete current configuration

delete

https://{managementIp}/rest/{version}/configuration/management

Deletes the current configuration located in the /code/data and /code/config directories from the system's flash memory.

Request

Path Parameters

• version(required): string
  REST API version string.
  Available values: v1.2

Query Parameters

• cached: boolean
  Optional parameter to delete the cached configuration.
  Available values: true, false

  Allowed Values: [ true, false ]

Header Parameters

• Authorization(required):
  The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml

204 Response

Successful deletion of the requested instance. There is no response body for a successful delete.

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

Body ()

Root Schema : response

Type: object

Show Source

• data(required): object data
• links(required): array links
• messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• link: string
  If available, a message with possible valid API URL(s) for the client to invoke

  Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorMessage: string
  Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

401 Response

Unauthorized - Request lacks valid authentication credentials.

Body ()

Root Schema : response

Type: object

Show Source

• data(required): object data
• links(required): array links
• messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• link: string
  If available, a message with possible valid API URL(s) for the client to invoke

  Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorMessage: string
  Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

403 Response

This request requires the client credentials to have administrator privileges.

Body ()

Root Schema : response

Type: object

Show Source

• data(required): object data
• links(required): array links
• messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• link: string
  If available, a message with possible valid API URL(s) for the client to invoke

  Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorMessage: string
  Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

404 Response

Resource not found

Body ()

Root Schema : response

Type: object

Show Source

• data(required): object data
• links(required): array links
• messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• link: string
  If available, a message with possible valid API URL(s) for the client to invoke

  Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorMessage: string
  Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

423 Response

The request requires the configuration lock and failed because the client does not currently own the lock. If another client or user currently owns the configuration lock, the error message is "Resource locked by another user". If no client or user owns the configuration lock, the error message is "User does not have the lock".

Body ()

Root Schema : response

Type: object

Show Source

• data(required): object data
• links(required): array links
• messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• link: string
  If available, a message with possible valid API URL(s) for the client to invoke

  Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorMessage: string
  Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a token.

• curl
• Python

The following example shows how to delete current configuration using curl.

curl -X DELETE \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.1/configuration/management"

The following example shows how to delete current configuration using Python.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.1/configuration/management"
resp = requests.delete(url, headers=headers)

Example of the Response Body

This endpoint does not return a response body.

Back to Top