Jump to

• Request
• Response
• Examples

Delete a file

post

http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/delete_files/deleteFile

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

A JSON object containing the file name to be deleted, path, and timestamp.

Root Schema : schema

Type: object

Show Source

• deletefile: string
  Example: APN_hd.log
• path: string
  Example: /home/talariuser/log
• timestamp: string
  Example: MK3jd4==

{
    "type":"object",
    "example":{
        "deletefile":"APN_db.log",
        "path":"/home/talariuser/log",
        "timestamp":"<timestamp>"
    },
    "properties":{
        "deletefile":{
            "type":"string",
            "example":"APN_hd.log"
        },
        "path":{
            "type":"string",
            "example":"/home/talariuser/log"
        },
        "timestamp":{
            "type":"string",
            "example":"MK3jd4=="
        }
    }
}

Example:

{
    "deletefile":"APN_db.log",
    "path":"/home/talariuser/log",
    "timestamp":"<timestamp>"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Result OK

Body ()

Root Schema : schema

Type: object

Show Source

• data: string
  Example: deleted file: /home/talariuser/log/APN_db.log
• status: string
  Example: success

{
    "type":"object",
    "example":{
        "status":"success",
        "data":"deleted file: /home/talariuser/log/APN_db.log"
    },
    "properties":{
        "status":{
            "type":"string",
            "example":"success"
        },
        "data":{
            "type":"string",
            "example":"deleted file: /home/talariuser/log/APN_db.log"
        }
    }
}

Example:

{
    "status":"success",
    "data":"deleted file: /home/talariuser/log/APN_db.log"
}

401 Response

Not Logged into the SDWAN-Edge device

Body ()

Root Schema : 401NotLoggedin

Type: object

Show Source

• message: string
  Example: Not logged in.
• status: string
  Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Not logged in."
        }
    }
}

403 Response

Insufficient Userlevel

Body ()

Root Schema : 403InsufficientUserLevel

Type: object

Show Source

• message: string
  Example: User Level for user <user_name> is not sufficient for this <URL value> operation.
• required_user_level: string
  Example: ADMIN
• status: string
  Example: fail
• user_level: string
  Example: GUEST
• user_name: string
  Example: username

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "user_name":{
            "type":"string",
            "example":"username"
        },
        "user_level":{
            "type":"string",
            "example":"GUEST"
        },
        "required_user_level":{
            "type":"string",
            "example":"ADMIN"
        },
        "message":{
            "type":"string",
            "example":"User Level for user <user_name> is not sufficient for this <URL value> operation."
        }
    }
}

405 Response

Invalid request method

Body ()

Root Schema : 405ExpectedPost

Type: object

Show Source

• message: string
  Example: Operation must use a POST
• status: string
  Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Operation must use a POST"
        }
    }
}

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to delete a file by submitting a POST request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X POST \
    -b cookies.txt \
    [e-mail] \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/manage_appliance/delete_files/deleteFile"

The following shows an example of the contents of the request.json file sent as the request body.

{
  "deletefile":"APN_db.log",
  "path":"/home/talariuser/log",
  "timestamp":<timestamp>
}

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
  "data": "deleted file: /home/talariuser/log/APN_db.log",
  "status": "success"
}

Back to Top