Jump to

• Request
• Response
• Examples

Delete an application instance

delete

/api/v1/applications

This API will delete an application instance, identified by the application instance ID.

Request

Supported Media Types

• application/json

Query Parameters

• applicationInstanceId: string
  The ID of the application instance to be deleted.

Header Parameters

• Authorization: string
  Contains authorization token receieved by making create token API call. The format is 'Bearer' followed by the token which starts with v2.
• X-Apprity-Tenant-Id: string
  The tenant ID for which you are making this call.

Back to Top

Response

Supported Media Types

• application/json
• application/gzip

200 Response

The application instance was successfully deleted from Oracle CASB Cloud Service.

Headers

• Authorization: string
  Contains authorization token receieved by making create token API call. The format is 'Bearer' followed by the token which starts with v2.
• X-Apprity-Tenant-Id: string
  The tenant ID for which you are making this call.

Body ()

Root Schema : ApplicationDeleteResponse

Type: object

The response body after successfully deleting an AWS instance.

Show Source

• applicationName(optional): string
  Name of the application, typically set to AWS, BOX, O365 etc. Currently, only AWS is supported.
• instanceId(optional): string
  ID of the application instance that was deleted by the call.
• instanceName(optional): string
  Name of the application instance that was deleted by the call.
• message(optional): string
  Message indicating success or failure of the API
• tenantId(optional): string
  ID of the tenant in which the application instance was deleted.

{
    "type":"object",
    "description":"The response body after successfully deleting an AWS instance. ",
    "properties":{
        "applicationName":{
            "type":"string",
            "description":"Name of the application, typically set to AWS, BOX, O365 etc. Currently, only AWS is supported. ",
            "xml":{
                "name":"applicationName"
            }
        },
        "instanceId":{
            "description":"ID of the application instance that was deleted by the call.",
            "type":"string",
            "xml":{
                "name":"instance-id"
            }
        },
        "instanceName":{
            "type":"string",
            "description":"Name of the application instance that was deleted by the call.",
            "xml":{
                "name":"instanceName"
            }
        },
        "tenantId":{
            "type":"string",
            "description":"ID of the tenant in which the application instance was deleted.",
            "xml":{
                "name":"tenant-id"
            }
        },
        "message":{
            "type":"string",
            "description":"Message indicating success or failure of the API "
        }
    }
}

400 Response

Bad request format. Check the response for more information on which fields are inaccurate. Ensure that you have a request which follows the format.

Body ()

Root Schema : Error

Type: object

Show Source

• code(optional): string
  HTTP Status Code.
• message(optional): string
  The error message.

{
    "type":"object",
    "properties":{
        "code":{
            "description":"HTTP Status Code.",
            "type":"string"
        },
        "message":{
            "description":"The error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized delete API call. See response for more details.

Body ()

Root Schema : Error

Type: object

Show Source

• code(optional): string
  HTTP Status Code.
• message(optional): string
  The error message.

{
    "type":"object",
    "properties":{
        "code":{
            "description":"HTTP Status Code.",
            "type":"string"
        },
        "message":{
            "description":"The error message.",
            "type":"string"
        }
    }
}

403 Response

Delete request is forbidden. It is likely the CASB APIs aren???t enabled for the tenant.

Body ()

Root Schema : Error

Type: object

Show Source

• code(optional): string
  HTTP Status Code.
• message(optional): string
  The error message.

{
    "type":"object",
    "properties":{
        "code":{
            "description":"HTTP Status Code.",
            "type":"string"
        },
        "message":{
            "description":"The error message.",
            "type":"string"
        }
    }
}

404 Response

Resource requested (instance ID) is not present.

Body ()

Root Schema : Error

Type: object

Show Source

• code(optional): string
  HTTP Status Code.
• message(optional): string
  The error message.

{
    "type":"object",
    "properties":{
        "code":{
            "description":"HTTP Status Code.",
            "type":"string"
        },
        "message":{
            "description":"The error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server error occured. See response for more details.

Body ()

Root Schema : Error

Type: object

Show Source

• code(optional): string
  HTTP Status Code.
• message(optional): string
  The error message.

{
    "type":"object",
    "properties":{
        "code":{
            "description":"HTTP Status Code.",
            "type":"string"
        },
        "message":{
            "description":"The error message.",
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to delete an AWS application instance by submitting a DELETE request.

Example URL: Deleting an Application Instance

https://<CASB-STACK>.casb.ocp.oraclecloud.com/api/v1/applications?applicationType=AWS&applicationInstanceId=e6d29a75-cdaf-4dfa-b35d-90c77899eb10

Example Response Body: Deleting an Application Instance

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

{
  "application-name": "e6d29a75-cdaf-4dfa-b35d-90c77899eb10",
  "tenant-id": "abcdefgh-1234-ijkl-5678-mnopqrstuvwx",
  "message": "Application removed successfully"
}

Back to Top