logo

Retrieve an application instance configuration

Retrieves the configuration of an installed application with a specified ID.

SecuritySecretApiKey or JWT or ApplicationJWT
Request
path Parameters
applicationId
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the application.

Responses
200

Application instance configuration retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
required
object

Configuration settings that are available during installation.

property name*
additional property
string

Additional properties that the user may want to add when installing an application.

Array of objects

Related links.

Array
rel
string

Type of link.

Enum: Description
self

Link to the application instance configuration.

configuration

Link to the external resource where the application instance must be configured. This field contains a JWT in the query parameter. Direct the user to this URL where application settings must be submitted.

href
string

Link URL.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/application-instances/{applicationId}/configuration
Request samples 
Response samples 
application/json
{
  • "settings": {
    },
  • "_links": [
    ]
}
➔ Next to Upsert an application instance configuration