Application Command Execution Controller Resource

The API allows you to list, view, create and edit application command executions.

GET /applications/configs

Returns list of application command executions.

Request Parameters
name type description
direction query
filter query
nameLike query
orderBy query
page query
size query
Response Body
media type data type description
application/json array of AppCmdExecConfigListRecord (JSON) list of application command executions

Example

Request
GET /applications/configs
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
} ]

POST /applications/configs

Create a application command execution.

Request Body
media type data type description
application/json AppCmdExecConfigRequest (JSON) specify details for new application command execution
Response Body
media type data type description
application/json AppCmdExecConfigDetails (JSON) details of newly created application command execution

Example

Request
POST /applications/configs
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}

GET /applications/configs/detailed

Returns detailed list of application command executions.

Response Body
media type data type description
application/json array of AppCmdExecConfigDetails (JSON) detailed list of application command executions

Example

Request
GET /applications/configs/detailed
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
} ]

GET /applications/configs/preview

Response Body
media type data type description
application/json array of AppCmdExecConfigListPreviewRecord (JSON)

Example

Request
GET /applications/configs/preview
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

GET /applications/configs/rbac-contexts

Returns list of application command executions.

Response Body
media type data type description
application/json array of RbacContextListRecord (JSON) list of application command executions

Example

Request
GET /applications/configs/rbac-contexts
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

DELETE /applications/configs/{guid}

Remove application command execution.

Request Parameters
name type description
guid path specify local unique identifier for application command execution (use by vProtect)

Example

Request
DELETE /applications/configs/{guid}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /applications/configs/{guid}

Get a single application command execution.

Request Parameters
name type description
guid path specify local unique identifier for application command execution (use by vProtect)
Response Body
media type data type description
application/json AppCmdExecConfigDetails (JSON) a single application command execution details

Example

Request
GET /applications/configs/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}

PUT /applications/configs/{guid}

Change application command execution details.

Request Parameters
name type description
guid path specify local unique identifier for application command execution (use by vProtect)
Request Body
media type data type description
application/json AppCmdExecConfigRequest (JSON) specify application command execution details to update
Response Body
media type data type description
application/json AppCmdExecConfigDetails (JSON) updated details of application command execution

Example

Request
PUT /applications/configs/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}

POST /applications/configs/{guid}/clone

Clone application command execution.

Request Parameters
name type description
guid path local unique identifier of application command execution that will be cloned
Request Body
media type data type description
application/json CloneDTO (JSON) specify details for new application command execution
Response Body
media type data type description
application/json AppCmdExecConfigDetails (JSON) details of newly created application command execution

Example

Request
POST /applications/configs/{guid}/clone
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}