Esper Subscription API

swagger: '2.0'
info:
  description: "# Introduction\nEsper APIs are a set of REST-based APIs that help you programmatically control and monitor Android-based Dedicated Devices running the Esper agent using Esper Manage. With these APIs, you can orchestrate and manage devices that have been provisioned against your Esper Manage environment. Furthermore, these APIs allows you to manage the Android applications installed on your Dedicated Device fleet. To read more about the various capabilities of Esper APIs and Esper managed devices, please visit [esper.io](https://esper.io). This guide describes all the available APIs in detail, along with code samples for you to quickly ramp up to using them.\\\nTo use these APIs you will need to create a developer account with Esper and get access to the Esper Dev Console and the Esper ManageDashboard. You can find out more about Esper and sign up for free at [esper.io/signup](https://esper.io/signup)\\\nWe've done our best to keep this document up to date, but if you find any issues, please reach out to us at developer@esper.io.\n\n# SDK\n\n  You are welcome to use your favorite HTTP/REST library for your programming language in order to call these APIs, or you can use our SDK (currently supporting [python](https://github.com/esper-io/esper-client-py)) to do so.\n\n\n# Authentication\nThe client needs to send authentication details to access the Esper APIs by generating and applying an API key. Be sure to sign up for your free trial account with Esper Dev to generate your key:\n\n# Errors\nThe APIs use standard HTTP status codes to indicate success or failure. All error responses will have a JSON body in the following format:\n\n```\n{\n  \"errors\": [],\n  \"message\": \"error message\",\n  \"status\": 400\n}\n```\n* `errors` -  List of error details\n* `message` - Error description\n* `status` - HTTP status code\n"
  version: 1.0.0
  title: ESPER API REFERENCE Application Subscription API
  termsOfService: https://esper.io/terms-of-service
  contact:
    email: developer@esper.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
host: foo-api.esper.cloud
basePath: /api
schemes:
- https
tags:
- name: Subscription
  description: APIs for Subscription management
  externalDocs:
    description: Find out more about Report
    url: https://docs.esper.io/home/console.html#subscription
paths:
  /v0/enterprise/{enterprise_id}/subscription/:
    get:
      operationId: getAllSubscriptions
      summary: List Subscriptions in Enterprise
      description: API to view all the subscriptions in an enterprise
      produces:
      - application/json
      parameters:
      - name: enterprise_id
        in: path
        description: A UUID string identifying the enterprise.
        required: true
        type: string
        format: uuid
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        type: integer
      - name: offset
        in: query
        description: The initial index from which to return the results.
        required: false
        type: integer
      responses:
        '200':
          description: successful operation
          schema:
            required:
            - count
            - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: url
                x-nullable: true
              previous:
                type: string
                format: url
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/EventSubscription'
      security:
      - apiKey: []
      tags:
      - Subscription
    post:
      operationId: createSubscription
      summary: Create a Subscription
      description: Returns Subscription instance
      produces:
      - application/json
      parameters:
      - name: data
        in: body
        required: true
        schema:
          $ref: '#/definitions/EventSubscriptionArgs'
      - name: enterprise_id
        in: path
        description: A UUID string identifying the enterprise.
        required: true
        type: string
        format: uuid
      responses:
        '201':
          description: successful operation
          schema:
            $ref: '#/definitions/EventSubscription'
      security:
      - apiKey: []
      tags:
      - Subscription
  /v0/enterprise/{enterprise_id}/subscription/{subscription_id}/:
    parameters:
    - name: subscription_id
      in: path
      description: A UUID string identifying the subscription.
      required: true
      type: string
      format: uuid
    - name: enterprise_id
      description: A UUID string identifying the enterprise.
      in: path
      required: true
      type: string
      format: uuid
    get:
      operationId: getSubscription
      summary: Get subscription information
      description: Returns subscription instance
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/EventSubscription'
      security:
      - apiKey: []
      tags:
      - Subscription
    delete:
      operationId: deleteSubscription
      summary: Delete a subscription
      description: Empty response
      produces:
      - application/json
      parameters: []
      responses:
        '204':
          description: successful operation
      security:
      - apiKey: []
      tags:
      - Subscription
definitions:
  EventSubscriptionArgs:
    required:
    - aws_account_id
    type: object
    properties:
      aws_account_id:
        title: AWS account Id
        type: string
        minLength: 1
  EventSubscription:
    required:
    - enterprise
    - aws_account_id
    type: object
    properties:
      id:
        title: Id
        type: string
        format: uuid
        readOnly: true
      aws_account_id:
        title: AWS account Id
        type: string
        minLength: 1
      sns_topic_arn:
        title: SNS topic arn
        type: string
        readOnly: true
      created_on:
        title: Created on
        type: string
        format: date-time
        readOnly: true
      updated_on:
        title: Updated on
        type: string
        format: date-time
        readOnly: true
      is_subscribed:
        title: Is subscribed
        type: boolean
      enterprise:
        title: Enterprise
        type: string
        format: url
securityDefinitions:
  apiKey:
    description: "#### API KEY - Access Token\nAccess token for APIs passed as authorization header in calls. You need to generate this from your Esper Dev Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper Dev account. Please follow the instructions [here](https://docs.esper.io/home/module/genapikey.html) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication scheme [here](https://console-docs.esper.io/API/generate.html).\n"
    name: Authorization
    type: apiKey
    in: header
x-tagGroups:
- name: API Reference
  tags:
  - Enterprise
  - Application
  - Application V1
  - Device
  - Device Group
  - Commands
  - Group Commands
  - Token
  - Commands V2
  - Enterprise Policy
  - Geofence
  - Reports
  - Subscription
  - Content