Applications
post /api/http/applications
Creates a new application. Marketplace application cannot be installed using this endpoint.
To create a multi-org application ( and connect application server to the current Space instance ) , pass connectToSpace = true
. Learn more about multi-org applications in the documentation.
Required permissions: Create applications
|
post /api/http/applications/error-message
Provide error message to display on application page in Space UI. Provide null
message to remove it.
|
post /api/http/applications/report-application-as-healthy
Application may periodically call this api method to notify Space that it is functioning properly. This is mandatory for applications that connect external issue trackers.
|
post /api/http/applications/{application}/force-remove
Removes the application that has previously failed to respond with code 200 to ApplicationUninstalledPayload
request, without sending additional ApplicationUninstalledPayload
requests. The application is archived and its access terminated.
Required permissions: Delete applications
|
post /api/http/applications/{application}/restore
Required permissions: Update applications
|
get /api/http/applications/paged
Required permissions: View applications
|
get /api/http/applications/{application}
Required permissions: View applications
|
patch /api/http/applications/{application}
Update existing application. Multi-org applications ( created with the parameter connectToSpace = true
or installed from JetBrains Marketplace ) can only be updated by the application itself. Learn more about multi-org applications in the documentation.
Required permissions: Update applications
|
delete /api/http/applications/{application}
Removes specified application. If the application is connected ( installed from Marketplace or through an install link ) , Space sends ApplicationUninstalledPayload
to the application ' s server. The application is only actually deleted when the application server responds or when the ApplicationUninstalledPayload
request times out multiple times.
This API method does not wait until the ApplicationUninstalledPayload
request is finished and instead returns immediately. Consequently, the application may still be active right after this API method call.
If sending ApplicationUninstalledPayload
has failed at least one time, a user may choose to force-remove the application. In this case the access for the application is terminated and it can no longer make requests.
Required permissions: Delete applications
|
get /api/http/applications/{application}/bearer-token
Required permissions: View application secrets
|
get /api/http/applications/{application}/last-client-credentials-access
Required permissions: View applications
|
get /api/http/applications/{application}/public-keys
Returns list of public keys in JWKS format. If message signature is successfully verified with any of the returned public keys, the message can be considered authentic.
Required permissions: View applications
|
patch /api/http/applications/ui-extensions
Set UI extensions supported by the calling application in specified context. Only the application itself can set its extensions.
|
get /api/http/applications/authorizations/authorized-applications
List applications authorized in specified context
Required permissions: View applications
|
get /api/http/applications/parameters
Return all application parameters. Only accessible with an app token, not a user token.
|
get /api/http/applications/parameters/{key}
Get application parameter by key. Only accessible with an app token, not a user token.
|
patch /api/http/applications/parameters/{key}
Set application parameter by key. Only accessible with an app token, not a user token. There is a limit of 100 app parameters per app. The key cannot be longer than 64 characters. The value cannot be longer than 1000 characters.
|
delete /api/http/applications/parameters/{key}
Remove application parameter by key. Only accessible with an app token, not a user token.
|
get /api/http/applications/parameters/profile
Return all profile parameters, profile and application are derived from the access token. Only accessible with a user token, issued to an application.
|
get /api/http/applications/parameters/profile/{key}
Get profile parameter by key, profile and application are derived from the access token. Only accessible with a user token, issued to an application.
|
patch /api/http/applications/parameters/profile/{key}
Set profile parameter by key, profile and application are derived from the access token. Only accessible with a user token, issued to an application. There is a limit of 100 app parameters per app per profile. The key cannot be longer than 64 characters. The value cannot be longer than 1000 characters.
|
delete /api/http/applications/parameters/profile/{key}
Remove profile parameter by key, profile and application are derived from the access token. Only accessible with a user token, issued to an application.
|
patch /api/http/applications/unfurls/domains
Update list of domains for unfurling by the application. Method is to be called by the application providing unfurls.
Required permissions: Update applications
|
patch /api/http/applications/unfurls/patterns
Update list of external ID prefixes for unfurling by the application. Method is to be called by the application providing unfurls.
Required permissions: Update applications
|
post /api/http/applications/unfurls/queue/content
Provide Space with unfurls content. Method is to be called by the application providing unfurls.
Required permissions: Provide external unfurls as attachments
|
post /api/http/applications/unfurls/queue/request-external-auth
Request user to authenticate in external system to provide unfurls from it. Method is to be called by the application providing unfurls.
Required permissions: Provide external unfurls as attachments
|
post /api/http/applications/unfurls/queue/reset-external-auth-requests
Clear all external system authentication requests for the specified user. Method is to be called by the application providing unfurls.
Required permissions: Provide external unfurls as attachments
|
get /api/http/applications/unfurls/queue
Get links for unfurling by the application. Method is to be called by the application providing unfurls.
Required permissions: Provide external unfurls as attachments
|
get /api/http/applications/{application}/authorizations/authorized-contexts
List authorized contexts of an application
Required permissions: View applications
|
get /api/http/applications/{application}/authorizations/authorized-rights
List authorized rights of an application in specified context
Required permissions: View applications
|
patch /api/http/applications/{application}/authorizations/authorized-rights
Generic method for editing authorized right status in given context.
|
delete /api/http/applications/{application}/authorizations/authorized-rights
Remove application authorization in specified context
|
patch /api/http/applications/{application}/authorizations/authorized-rights/request-rights
Request rights for an application in specified context
Required permissions: Update applications
|
get /api/http/applications/{application}/authorizations/required-rights
List required rights for an application
Required permissions: View applications
|
patch /api/http/applications/{application}/authorizations/required-rights
Update list of required rights for an application
Required permissions: Update applications
|
post /api/http/applications/{application}/client-secret/regenerate
Required permissions: Update applications
|
get /api/http/applications/{application}/client-secret
Required permissions: View application secrets
|
post /api/http/applications/{application}/gpg-keys
Required permissions: Update applications
|
get /api/http/applications/{application}/gpg-keys
Required permissions: View applications
|
patch /api/http/applications/{application}/gpg-keys/{fingerprint}
Required permissions: Update applications
|
delete /api/http/applications/{application}/gpg-keys/{fingerprint}
Required permissions: Update applications
|
post /api/http/applications/{application}/permanent-tokens
Create a permanent token for the given application that can be used to access the current organization
Required permissions: Update applications
|
get /api/http/applications/{application}/permanent-tokens
Get permanent tokens used to access the current organization by the given application
Required permissions: View application secrets
|
patch /api/http/applications/{application}/permanent-tokens/{tokenId}
Update an existing personal token used to access the current organization. The permanent token ' s name and/or scope can be updated.
Required permissions: Update applications
|
delete /api/http/applications/{application}/permanent-tokens/{tokenId}
Delete a personal token used to access the current organization
Required permissions: Update applications
|
delete /api/http/applications/{application}/permanent-tokens/current
Delete personal token of the given application
|
post /api/http/applications/{application}/signing-key/regenerate
Required permissions: Update applications
|
get /api/http/applications/{application}/signing-key
Required permissions: View application secrets
|
post /api/http/applications/{application}/ssh-keys
Required permissions: Update applications
|
get /api/http/applications/{application}/ssh-keys
Required permissions: View applications
|
delete /api/http/applications/{application}/ssh-keys/{fingerprint}
Required permissions: Update applications
|
get /api/http/applications/{application}/ui-extensions
Get UI extensions supported by the application in specified context. Omit contextIdentifier to get UI extensions in all contexts
Required permissions: View applications
|
patch /api/http/applications/{application}/ui-extensions/disable-for-everybody
Disable application UI for everybody in specified context. Requires Superadmin right for global context, AdminProject for project context, AdminChannel for channel context. Users will still be able to enable application UI individually.
Required permissions: View applications
, Grant permissions to other members
, Manage project permission scheme
, Manage channels
|
patch /api/http/applications/{application}/ui-extensions/disable-for-me
Disable application UI in specified context for the current user
Required permissions: View applications
|
patch /api/http/applications/{application}/ui-extensions/enable-for-everybody
Enable application UI for everybody in specified context. Requires Superadmin right for global context, AdminProject for project context, AdminChannel for channel context. Users will still be able to disable application UI individually.
Required permissions: View applications
, Grant permissions to other members
, Manage project permission scheme
, Manage channels
|
patch /api/http/applications/{application}/ui-extensions/enable-for-me
Enable application UI in specified context for the current user
Required permissions: View applications
|
post /api/http/applications/{application}/unfurl-domains/authorize
Authorize domains for unfurling by the application
Required permissions: Authorize domains and patterns for app-powered previews
|
get /api/http/applications/{application}/unfurl-domains
List domains for unfurling by the application
Required permissions: View applications
|
post /api/http/applications/{application}/unfurl-patterns/authorize
Authorize patterns for unfurling by the application
Required permissions: Authorize domains and patterns for app-powered previews
|
get /api/http/applications/{application}/unfurl-patterns
List patterns for unfurling by the application
Required permissions: View applications
|
post /api/http/applications/{application}/verification-token/regenerate
Required permissions: Update applications
|
get /api/http/applications/{application}/verification-token
Required permissions: View application secrets
|
post /api/http/applications/{application}/webhooks
Create application webhook
Required permissions: Update applications
|
get /api/http/applications/{application}/webhooks
Get application webhooks
Required permissions: View applications
|
post /api/http/applications/{application}/webhooks/{webhookId}
Restore archived application webhook
Required permissions: Update applications
|
patch /api/http/applications/{application}/webhooks/{webhookId}
Update application webhook
Required permissions: Update applications
|
delete /api/http/applications/{application}/webhooks/{webhookId}
Archive application webhook
Required permissions: Update applications
|
get /api/http/applications/{application}/webhooks/{webhookId}/bearer-token
Required permissions: View application secrets
|
post /api/http/applications/{application}/webhooks/{webhookId}/custom-headers
Required permissions: Update applications
|
get /api/http/applications/{application}/webhooks/{webhookId}/custom-headers
Required permissions: View application secrets
|
post /api/http/applications/{application}/webhooks/{webhookId}/signing-key/regenerate
Required permissions: Update applications
|
get /api/http/applications/{application}/webhooks/{webhookId}/signing-key
Required permissions: View application secrets
|
post /api/http/applications/{application}/webhooks/{webhookId}/subscriptions
Add webhook subscription
Required permissions: Update applications
|
get /api/http/applications/{application}/webhooks/{webhookId}/subscriptions
Get webhook subscriptions
Required permissions: View applications
|
post /api/http/applications/{application}/webhooks/{webhookId}/subscriptions/{subscriptionId}/request-missing-rights
Ensures that all permissions required for this subscription are requested in the corresponding permission role
|
patch /api/http/applications/{application}/webhooks/{webhookId}/subscriptions/{subscriptionId}
Update webhook subscription
Required permissions: Update applications
|
delete /api/http/applications/{application}/webhooks/{webhookId}/subscriptions/{subscriptionId}
Delete webhook subscription
Required permissions: Update applications
|
Thanks for your feedback!