App installation API (V2). View and install Sumo Logic Applications that deliver out-of-the-box dashboards, saved searches, and field extraction for popular data sources. For more information, see [Sumo Logic Apps](https://help.sumologic.com/docs/integrations).
openapi: 3.0.0
info:
title: Sumo Logic accessKeyManagement appManagementV2 API
description: "# Getting Started\nWelcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on Collector and Search Job APIs, see our [API home page](https://help.sumologic.com/docs/api).\n## API Endpoints\nSumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\n\n <table>\n <tr>\n <td> <strong>Deployment</strong> </td>\n <td> <strong>Endpoint</strong> </td>\n </tr>\n <tr>\n <td> AU </td>\n <td> https://api.au.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> CA </td>\n <td> https://api.ca.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> DE </td>\n <td> https://api.de.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> EU </td>\n <td> https://api.eu.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> FED </td>\n <td> https://api.fed.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> IN </td>\n <td> https://api.in.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> JP </td>\n <td> https://api.jp.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> KR </td>\n <td> https://api.kr.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US1 </td>\n <td> https://api.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US2 </td>\n <td> https://api.us2.sumologic.com/api/ </td>\n </tr>\n </table>\n\n## Authentication\nSumo Logic supports the following options for API authentication:\n- Access ID and Access Key\n- Base64 encoded Access ID and Access Key\n\nSee [Access Keys](https://help.sumologic.com/docs/manage/security/access-keys) to generate an Access Key. Make sure to copy the key you create, because it is displayed only once.\nWhen you have an Access ID and Access Key you can execute requests such as the following:\n ```bash\n curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\nWhere `deployment` is either `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1`, or `us2`. See [API endpoints](#section/API-Endpoints) for details.\n\nIf you prefer to use basic access authentication, you can do a Base64 encoding of your `<accessId>:<accessKey>` to authenticate your HTTPS request. The following is an example request, replace the placeholder `<encoded>` with your encoded Access ID and Access Key string:\n ```bash\n curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\n\nRefer to [API Authentication](https://help.sumologic.com/?cid=3012) for a Base64 example.\n\n## Status Codes\nGeneric status codes that apply to all our APIs. See the [HTTP status code registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) for reference.\n <table>\n <tr>\n <td> <strong>HTTP Status Code</strong> </td>\n <td> <strong>Error Code</strong> </td>\n <td> <strong>Description</strong> </td>\n </tr>\n <tr>\n <td> 301 </td>\n <td> moved </td>\n <td> The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details.</td>\n </tr>\n <tr>\n <td> 401 </td>\n <td> unauthorized </td>\n <td> Credential could not be verified.</td>\n </tr>\n <tr>\n <td> 403 </td>\n <td> forbidden </td>\n <td> This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details.</td>\n </tr>\n <tr>\n <td> 404 </td>\n <td> notfound </td>\n <td> Requested resource could not be found. </td>\n </tr>\n <tr>\n <td> 405 </td>\n <td> method.unsupported </td>\n <td> Unsupported method for URL. </td>\n </tr>\n <tr>\n <td> 415 </td>\n <td> contenttype.invalid </td>\n <td> Invalid content type. </td>\n </tr>\n <tr>\n <td> 429 </td>\n <td> rate.limit.exceeded </td>\n <td> The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. </td>\n </tr>\n <tr>\n <td> 500 </td>\n <td> internal.error </td>\n <td> Internal server error. </td>\n </tr>\n <tr>\n <td> 503 </td>\n <td> service.unavailable </td>\n <td> Service is currently unavailable. </td>\n </tr>\n </table>\n\n## Filtering\nSome API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand `&` character.\n\nExample: To get user with email `john@demo.com`:\n ```bash\n api.sumologic.com/v1/users?email=john@demo.com\n ```\n\n## Sorting\nSome API endpoints support sorting fields by using the `sortBy` query parameter. The default sort order is ascending. Prefix the field with a minus sign `-` to sort in descending order.\n\nFor example, to get 20 users sorted by their `email` in descending order:\n ```bash\n api.sumologic.com/v1/users?limit=20&sort=-email\n ```\n\n## Asynchronous Request\nAsynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.\n1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies\n your asynchronous job.\n\n2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous\n request will typically provide an endpoint to poll for the status of asynchronous job. A successful response\n from the status endpoint will have the following structure:\n ```json\n {\n \"status\": \"Status of asynchronous request\",\n \"statusMessage\": \"Optional message with additional information in case request succeeds\",\n \"error\": \"Error object in case request fails\"\n }\n ```\n The `status` field can have one of the following values:\n 1. `Success`: The job succeeded. The `statusMessage` field might have additional information.\n 2. `InProgress`: The job is still running.\n 3. `Failed`: The job failed. The `error` field in the response will have more information about the failure.\n\n3. Some asynchronous APIs may provide a third endpoint (like [export result](#operation/getAsyncExportResult))\n to fetch the result of an asynchronous job.\n\n\n### Example\nLet's say we want to export a folder with the identifier `0000000006A2E86F`. We will use the [async export](#operation/beginAsyncExport) API to export all the content under the folder with `id=0000000006A2E86F`.\n1. Start an export job for the folder\n ```bash\n curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export\n ```\n See [authentication section](#section/Authentication) for more details about `accessId`, `accessKey`, and\n `deployment`.\n On success, you will get back a job identifier. In the response below, `C03E086C137F38B4` is the job identifier.\n ```bash\n {\n \"id\": \"C03E086C137F38B4\"\n }\n ```\n\n2. Now poll for the status of the asynchronous job with the [status](#operation/getAsyncExportStatus) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status\n ```\n You may get a response like\n ```json\n {\n \"status\": \"InProgress\",\n \"statusMessage\": null,\n \"error\": null\n }\n ```\n It implies the job is still in progress. Keep polling till the status is either `Success` or `Failed`.\n\n3. When the asynchronous job completes (`status != \"InProgress\"`), you can fetch the results with the\n [export result](#operation/getAsyncExportResult) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result\n ```\n\n The asynchronous job may fail (`status == \"Failed\"`). You can look at the `error` field for more details.\n ```json\n {\n \"status\": \"Failed\",\n \"errors\": {\n \"code\": \"content1:too_many_items\",\n \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"\n }\n }\n ```\n\n\n## Rate Limiting\n* A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.\n* A rate limit of 10 concurrent requests to any API endpoint applies to an access key.\n\nIf a rate is exceeded, a rate limit exceeded 429 status code is returned.\n\n## Generating Clients\nYou can use [OpenAPI Generator](https://openapi-generator.tech) to generate clients from the YAML file to access the API.\n\n### Using [NPM](https://www.npmjs.com/get-npm)\n1. Install [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) globally, exposing the CLI\n on the command line:\n ```bash\n npm install @openapitools/openapi-generator-cli -g\n ```\n You can see detailed instructions [here](https://openapi-generator.tech/docs/installation#npm).\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n\n\n### Using [Homebrew](https://brew.sh/)\n1. Install OpenAPI Generator\n ```bash\n brew install openapi-generator\n ```\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client side code inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n"
version: 1.0.0
x-logo:
url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
description: CA deployment API server
- url: https://api.de.sumologic.com/api/
description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
description: KR deployment API server
- url: https://api.in.sumologic.com/api/
description: IN deployment API server
- url: https://api.sumologic.com/api/
description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: appManagementV2
description: 'App installation API (V2).
View and install Sumo Logic Applications that deliver out-of-the-box dashboards, saved searches, and field extraction for popular data sources. For more information, see [Sumo Logic Apps](https://help.sumologic.com/docs/integrations).
'
x-displayName: Apps V2 (Beta)
paths:
/v2/apps/{uuid}/install:
post:
tags:
- appManagementV2
summary: Start App Install Job
description: 'Schedule an asynchronous job to install the app with the given UUID and version from the App Catalog. The app will be installed in ''Installed Apps'' folder in the Content Library.
_You get back an identifier of asynchronous job in response to this endpoint. You can then use the [app install status API](#operation/getAsyncInstallAppStatus) to get the status of the installation request. See [Asynchronous-Request](#section/Getting-Started/Asynchronous-Request) section for more details on how to work with asynchronous request._'
operationId: asyncInstallApp
parameters:
- name: uuid
in: path
description: UUID of the app to install.
required: true
schema:
type: string
example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5
requestBody:
description: Information about the app to install.
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncInstallAppRequest'
required: true
responses:
'200':
description: App installation job has been scheduled.
content:
application/json:
schema:
$ref: '#/components/schemas/BeginAsyncJobResponseV2'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/apps/install/{jobId}/status:
get:
tags:
- appManagementV2
summary: App Install Job Status
description: Get the status of an asynchronous app install request for the given job identifier.
operationId: getAsyncInstallAppStatus
parameters:
- name: jobId
in: path
description: Identifier of the asynchronous job for installing the app.
required: true
schema:
type: string
example: C03E086C137F38B4
responses:
'200':
description: Status of the app installation job.
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncInstallAppJobStatus'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/apps/{uuid}/uninstall:
post:
tags:
- appManagementV2
summary: Start App Uninstall Job
description: 'Schedule an asynchronous job to uninstall app with the given UUID.
_You get back an identifier of asynchronous job in response to this endpoint. You can then use the [app uninstall status API](#operation/getAsyncUninstallAppStatus) to get the status of the uninstallation request. See [Asynchronous-Request](#section/Getting-Started/Asynchronous-Request) section for more details on how to work with asynchronous request._'
operationId: asyncUninstallApp
parameters:
- name: uuid
in: path
description: UUID of the app to uninstall.
required: true
schema:
type: string
example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5
responses:
'200':
description: App uninstall job has been scheduled.
content:
application/json:
schema:
$ref: '#/components/schemas/BeginAsyncJobResponseV2'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/apps/uninstall/{jobId}/status:
get:
tags:
- appManagementV2
summary: App Uninstall Job Status
description: Get the status of an asynchronous app uninstall request for the given job identifier.
operationId: getAsyncUninstallAppStatus
parameters:
- name: jobId
in: path
description: Identifier of the asynchronous job for uninstalling the app.
required: true
schema:
type: string
example: C03E086C137F38B4
responses:
'200':
description: Status of the app uninstall job.
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncUninstallAppJobStatus'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/apps/{uuid}/upgrade:
post:
tags:
- appManagementV2
summary: Start App Upgrade Job
description: 'Schedule an asynchronous job to upgrade the app with the given UUID and version from the App Catalog. The app will be installed in ''Installed Apps'' folder in the Content Library.
_You get back an identifier of asynchronous job in response to this endpoint. You can then use the [app upgrade status API](#operation/getAsyncUpgradeAppStatus) to get the status of the upgrade request. See [Asynchronous-Request](#section/Getting-Started/Asynchronous-Request) section for more details on how to work with asynchronous request._'
operationId: asyncUpgradeApp
parameters:
- name: uuid
in: path
description: UUID of the app to upgrade.
required: true
schema:
type: string
example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5
requestBody:
description: Information about the app to upgrade.
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncUpgradeAppRequest'
required: true
responses:
'200':
description: App upgrade job has been scheduled.
content:
application/json:
schema:
$ref: '#/components/schemas/BeginAsyncJobResponseV2'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/apps/upgrade/{jobId}/status:
get:
tags:
- appManagementV2
summary: App Upgrade Job Status
description: Get the status of an asynchronous app upgrade request for the given job identifier.
operationId: getAsyncUpgradeAppStatus
parameters:
- name: jobId
in: path
description: Identifier of the asynchronous job for upgrading the app.
required: true
schema:
type: string
example: C03E086C137F38B4
responses:
'200':
description: Status of the app upgrade job.
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncUpgradeAppJobStatus'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/apps:
get:
tags:
- appManagementV2
summary: List Apps
description: List all apps from the App Catalog.
operationId: listAppsV2
parameters:
- name: name
in: query
description: Name of the app.
required: false
schema:
type: string
example: AWS%20CloudTrail
- name: author
in: query
description: Author of the app.
required: false
schema:
type: string
example: Sumo%20Logic
responses:
'200':
description: List of apps.
content:
application/json:
schema:
$ref: '#/components/schemas/ListAppsV2Response'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/apps/{uuid}/details:
get:
tags:
- appManagementV2
summary: Get Details Of An App Version.
description: "Get details about an app with the given UUID and version. The details include:\n\n 1. The base URL for all the resource for the app.\n 2. The app manifest"
operationId: getAppDetails
parameters:
- name: uuid
in: path
description: UUID of the app.
required: true
schema:
type: string
example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5
- name: version
in: query
description: Version of the app. The latest version is used if this is omitted or specified as "latest".
required: false
schema:
type: string
example: 1.0.0
responses:
'200':
description: Information about the requested app.
content:
application/json:
schema:
$ref: '#/components/schemas/GetAppDetailsResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/apps/{uuid}/subscription:
get:
tags:
- appManagementV2
summary: Get Subscription Status For The User
description: Get Subscription status for the user for a specific app. This will indicate whether the user has subscribed to the app or not.
operationId: getAppNotificationSubscriptionStatus
parameters:
- name: uuid
in: path
description: UUID of the app.
required: true
schema:
type: string
example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5
responses:
'200':
description: Information about user's subscription status for the app.
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionStatusResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- appManagementV2
summary: Subscribe To An App Upgrade Notification
description: Subscribe to an app upgrade notification. This will allow the user to receive notifications for the app updates.
operationId: subscribeToAppNotification
parameters:
- name: uuid
in: path
description: UUID of the app to subscribe to.
required: true
schema:
type: string
example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5
responses:
'204':
description: Successfully subscribed to the app notification.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- appManagementV2
summary: Unsubscribe From An App Upgrade Notification
description: Unsubscribe from an app. This will remove the user's subscription to notifications for the app.
operationId: unsubscribeFromAppNotification
parameters:
- name: uuid
in: path
description: UUID of the app to unsubscribe from.
required: true
schema:
type: string
example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5
responses:
'204':
description: App Notification unsubscription was successful.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
GetAppDetailsResponse:
required:
- baseUrl
- manifest
- uuid
- version
type: object
properties:
uuid:
type: string
description: UUID of the app.
format: uuid
example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5
version:
type: string
description: Version of the app.
example: 1.0.0
baseUrl:
type: string
description: URL prefix for where the app is stored.
format: url
example: https://some_bucket.s3.amazonaws.com/path/to/app/version/
manifest:
type: string
description: Content of the manifest YAML file, as Base64-encoded string.
format: byte
config:
type: string
description: Content of the config YAML file, as Base64-encoded string.
format: byte
readme:
type: string
description: Content of the README markdown file, as Base64-encoded string.
format: byte
files:
maxProperties: 100
type: object
additionalProperties:
type: string
format: byte
description: Content of various files part of app package, as Base64-encoded string.
example:
config: ICAtIGNvbXBvbmVudFR5cGU6IHNjb3BlCiAgICBsYWJlbDog4oCYQXBhY2hlIEVycm9yIExvZyBT b3VyY2XigJkKICAgIHRmVmFyOiBlcnJMb2dTY29wZQogICAgCiAgLSBjb21wb25lbnRUeXBlOiBz Y29wZQogICAgbGFiZWw6IOKAmEFwYWNoZSBBY2Nlc3MgTG9nIFNvdXJjZeKAmQogICAgdGZWYXI6 IGFjY2Vzc0xvZ1Njb3BlCgogIC0gY29tcG9uZW50VHlwZTogY3VzdG9tCiAgICBkYXRhVHlwZTog U3RyaW5nCiAgICBsYWJlbDog4oCYQXBhY2hlIEVuZ2luZSBUeXBl4oCYCiAgICBoZWxwVGV4dDog 4oCYVGhlIGVuZ2luZSB0eXBlIG9mIHlvdXIgQXBhY2hlIEluc3RhbmNl4oCYCiAgICByZXF1aXJl ZDogRmFsc2UKICAgIGRlZmF1bHQ6IOKAmHYxLjDigJkKICAgIHRmVmFyOiBlbmdpbmVUeXBlCg==
readme: IyBPdmVydmlldwoKVGhlIEFwYWNoZSBhcHAgaXMgYSB1bmlmaWVkIGxvZ3MgYW5kIG1ldHJpY3Mg YXBwIHRoYXQgaGVscHMgeW91IG1vbml0b3IgdGhlIGF2YWlsYWJpbGl0eSwgcGVyZm9ybWFuY2Us IGhlYWx0aCBhbmQgcmVzb3VyY2UgdXRpbGl6YXRpb24gb2YgQXBhY2hlIHdlYiBzZXJ2ZXIgZmFy bXMuICBQcmVjb25maWd1cmVkIGRhc2hib2FyZHMgYW5kIHNlYXJjaGVzIHByb3ZpZGUgaW5zaWdo dCBpbnRvIHZpc2l0b3IgbG9jYXRpb25zLCB2aXNpdG9yIGFjY2VzcyB0eXBlcywgdHJhZmZpYyBw YXR0ZXJucywgZXJyb3JzLCB3ZWIgc2VydmVyIG9wZXJhdGlvbnMsIHJlc291cmNlIHV0aWxpemF0 aW9uIGFuZCBhY2Nlc3MgZnJvbSBrbm93biBtYWxpY2lvdXMgc291cmNlcy4KCiMgU2V0dXAKVGhp cyBpcyB0aGUgc2VjdGlvbiBmb3IgQXBhY2hlIC0gT3BlblRlbGVtZXRyeSBjb2xsZWN0aW9uIHNl dHVwLgo=
manifest: CnNjaGVtYVZlcnNpb246ICIxLjAiCgpuYW1lOiBBcGFjaGUKCmRlc2NyaXB0aW9u OiA+LQogIFRoZSBBcGFjaGUgYXBwIGlzIGEgdW5pZmllZCBsb2dzIGFuZCBtZXRy aWNzIGFwcCB0aGF0IGhlbHBzIHlvdSBtb25pdG9yIHRoZSBhdmFpbGFiaWxpdHks IHBlcmZvcm1hbmNlLAogIGhlYWx0aCBhbmQgcmVzb3VyY2UgdXRpbGl6YXRpb24g b2YgQXBhY2hlIHdlYiBzZXJ2ZXIgZmFybXMuICBQcmVjb25maWd1cmVkIGRhc2hi b2FyZHMgYW5kIHNlYXJjaGVzCiAgcHJvdmlkZSBpbnNpZ2h0IGludG8gdmlzaXRv ciBsb2NhdGlvbnMsIHZpc2l0b3IgYWNjZXNzIHR5cGVzLCB0cmFmZmljIHBhdHRl cm5zLCBlcnJvcnMsIHdlYiBzZXJ2ZXIKICBvcGVyYXRpb25zLCByZXNvdXJjZSB1 dGlsaXphdGlvbiBhbmQgYWNjZXNzIGZyb20ga25vd24gbWFsaWNpb3VzIHNvdXJj ZXMuCmF1dGhvcjogU3VtbyBMb2dpYwoKdmVyc2lvbjogMS4wLjAKCgo=
description: Information about an app.
ErrorResponse:
required:
- errors
- id
type: object
properties:
id:
type: string
description: An identifier for the error; this is unique to the specific API request.
example: IUUQI-DGH5I-TJ045
errors:
type: array
description: A list of one or more causes of the error.
example:
- code: auth:password_too_short
message: Your password was too short.
- code: auth:password_character_classes
message: Your password did not contain any non-alphanumeric characters
items:
$ref: '#/components/schemas/ErrorDescription'
SubscriptionStatusResponse:
required:
- status
type: object
properties:
status:
type: boolean
description: Show if the user has subscribed to the app or not. value is true, if the user has subscribed to the app
example: true
description: Subscription Status
AsyncUpgradeAppJobStatus:
required:
- status
type: object
properties:
status:
type: string
description: Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`).
example: Success
instanceId:
type: string
description: Instance identifier of the upgraded app. This field is not set yet but is a placeholder for future use.
example: 0000000001578BE8
path:
type: string
description: Path of the folder in which the app was upgraded.
example: /Library/Installed Apps/AWS CloudTrail
folderId:
type: string
description: Identifier of the folder in which the app was upgraded.
example: 0000000001578BE8
error:
$ref: '#/components/schemas/ErrorDescription'
description: Status of the upgrade app async job.
AsyncInstallAppRequest:
type: object
properties:
version:
type: string
description: 'Version of the app to install. You can either specify a specific version of the app or use `latest` to install the latest version of the app. _If version is not specified, the latest version of the app will be installed_.
'
example: 1.0.1
default: latest
parameters:
maxProperties: 1000
type: object
additionalProperties:
type: string
description: Map of additional parameters for the app installation.
example:
db_system: redis
description: Install app request.
AsyncUpgradeAppRequest:
type: object
properties:
version:
type: string
description: 'Version of the app to upgrade. You can either specify a specific version of the app or use `latest` to install the latest version of the app. _If version is not specified, the latest version of the app will be installed_.
'
example: 1.0.1
default: latest
parameters:
maxProperties: 1000
type: object
additionalProperties:
type: string
description: Map of additional parameters for the app installation.
example:
db_system: redis
description: Upgrade app request.
ErrorDescription:
required:
- code
- message
type: object
properties:
code:
type: string
description: An error code describing the type of error.
example: auth:password_too_short
message:
type: string
description: A short English-language description of the error.
example: Your password was too short.
detail:
type: string
description: An optional fuller English-language description of the error.
example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
meta:
type: object
description: An optional list of metadata about the error.
example:
minLength: 12
actualLength: 5
ListAppsV2Response:
required:
- apps
type: object
properties:
apps:
type: array
description: An array of apps.
items:
$ref: '#/components/schemas/AppV2'
description: List of all apps from the apps
AsyncUninstallAppJobStatus:
required:
- status
type: object
properties:
status:
type: string
description: Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`).
example: Success
errors:
type: array
description: More information about the failure if the status is `Failed`.
items:
$ref: '#/components/schemas/ErrorDescription'
description: Status of an uninstall app job.
AppV2:
required:
- accountTypes
- attributes
- author
- beta
- description
- family
- icon
- installable
- latestVersion
- name
- showOnMarketplace
- uuid
type: object
properties:
uuid:
type: string
description: UUID of the app.
example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5
name:
type: string
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sumo-logic/refs/heads/main/openapi/sumo-logic-appmanagementv2-api-openapi.yml