ApplicationsApi
| Method | HTTP request | Description |
|---|---|---|
| create_admin_api_application_using_post | POST /api/web/v1/applications/adminapi | Create Admin API application |
| get_admin_api_application_using_get | GET /api/web/v1/applications/adminapi/{id} | Get Admin API application |
| list_admin_api_applications_using_get | GET /api/web/v1/applications/adminapi | List Admin API application |
| list_application_info_using_get | GET /api/web/v1/applicationinfo | List application information |
| list_application_templates_using_get | GET /api/web/v1/applications/templates | List application templates |
| remove_admin_api_application_using_delete | DELETE /api/web/v1/applications/adminapi/{id} | Remove Admin API application |
| update_admin_api_application_using_put | PUT /api/web/v1/applications/adminapi/{id} | Update Admin API application |
| update_admin_api_shared_secret_using_put | PUT /api/web/v1/applications/adminapi/regenerate/{id} | Regenerate Admin API application shared secret |
create_admin_api_application_using_post
AdminApiApplication create_admin_api_application_using_post(admin_api_application_parms)
Create Admin API application
Create an Admin API application. Caller requires the APPLICATIONS:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| admin_api_application_parms | AdminApiApplicationParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_admin_api_application_using_get
AdminApiApplication get_admin_api_application_using_get(id)
Get Admin API application
Get an Admin API application. Caller requires the APPLICATIONS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the application to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
list_admin_api_applications_using_get
List[AdminApiApplication] list_admin_api_applications_using_get()
List Admin API application
List Admin API application. Caller requires the APPLICATIONS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
list_application_info_using_get
List[ApplicationInfo] list_application_info_using_get()
List application information
List application information. Caller requires the APPLICATIONS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
list_application_templates_using_get
List[ApplicationTemplate] list_application_templates_using_get()
List application templates
List application templates. Caller requires the TEMPLATES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
remove_admin_api_application_using_delete
remove_admin_api_application_using_delete(id)
Remove Admin API application
Remove an Admin API application. Caller requires the APPLICATIONS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the application to be removed. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
update_admin_api_application_using_put
AdminApiApplication update_admin_api_application_using_put(id, admin_api_application_parms)
Update Admin API application
Update an Admin API application. Caller requires the APPLICATIONS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the application to be updated. | |
| admin_api_application_parms | AdminApiApplicationParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
update_admin_api_shared_secret_using_put
str update_admin_api_shared_secret_using_put(id)
Regenerate Admin API application shared secret
Regenerate the shared secret for an Admin API application. Caller requires the APPLICATIONS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the application to be updated. |
Return type
str
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |