/application

PreviousAPI Specification Next/application/configuration

Last updated 11 days ago

Search Applications

Performs a full-text search of all applications known to the server. As with other full-text endpoints this allows for pagination and offset.

get

/application

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a New Application

Gets the metadata for a single application. This may include more specific details not available in the bulk-get or fetch operation.

post

/application

Authorizations

Body

nameanyrequired

Pattern: [^_]\w+

descriptionany

attributesany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": null,
    "description": null,
    "attributes": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Get an Application

Gets the metadata for a single application. This may include more specific details not availble in the bulk-get or fetch operation.

get

/application/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates an Application

Performs an update to an existing application known to the server.

put

/application/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Body

nameanyrequired

Pattern: [^_]\w+

descriptionany

attributesany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": null,
    "description": null,
    "attributes": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes an Application

Deletes a specific application known to the server.

delete

/application/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}