Scalr Webhook Endpoints API

openapi: 3.2.0
info:
  description: Manage Roles, Images, Environments and etc.
  title: Scalr Account Acl Roles Webhook Endpoints API
  version: 1.0.0
servers:
- url: /api/v1beta0/account
tags:
- name: Webhook Endpoints
paths:
  /{accountId}/webhook-endpoints/:
    parameters:
    - description: The ID of the Account scoping this request.
      in: path
      name: accountId
      required: true
      schema:
        type: integer
    get:
      description: List all the Webhook endpoints available in this Account.
      responses:
        200:
          description: A list of WebhookEndpoint objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointListResponse'
        400:
          description: A client-side error was made.
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached.
            name: ServersPerFarmQuotaExceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          x-errorCodes:
          - description: This endpoint does not exist.
            name: EndpointNotFound
            noDoc: true
          - description: The object you are trying to access does not exist.
            name: ObjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          x-errorCodes:
          - description: These changes aren't possible while this object is in use.
            name: ObjectInUse
          - description: These changes would violate a policy.
            name: PolicyViolation
          - description: These changes would violate a unicity constraint.
            name: UnicityViolation
          - description: Some of the objects being changed are locked and cannot be changed.
            name: Locked
          - description: This Cloud platform is not enabled.
            name: NotEnabledPlatform
          - description: The Operating System does not match.
            name: OperatingSystemMismatch
          - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid.
            name: UnacceptableObjectConfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Webhook Endpoints
  /{envId}/webhook-endpoints/:
    parameters:
    - description: The ID of the Environment scoping this request.
      in: path
      name: envId
      required: true
      schema:
        type: integer
    get:
      description: List all the Webhook endpoints available in this Environment.
      responses:
        200:
          description: A list of WebhookEndpoint objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointListResponse_2'
        400:
          description: A client-side error was made.
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse_2'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse_2'
        403:
          description: Insufficient permissions.
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached.
            name: ServersPerFarmQuotaExceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse_2'
        404:
          description: Resource not found.
          x-errorCodes:
          - description: This endpoint does not exist.
            name: EndpointNotFound
            noDoc: true
          - description: The object you are trying to access does not exist.
            name: ObjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse_2'
        409:
          description: Conflict with current state.
          x-errorCodes:
          - description: These changes aren't possible while this object is in use.
            name: ObjectInUse
          - description: These changes would violate a policy.
            name: PolicyViolation
          - description: These changes would violate a unicity constraint.
            name: UnicityViolation
          - description: Some of the objects being changed are locked and cannot be changed.
            name: Locked
          - description: This Cloud platform is not enabled.
            name: NotEnabledPlatform
          - description: The Operating System does not match.
            name: OperatingSystemMismatch
          - description: Some of the objects or actions being access are deprecated.
            name: Deprecated
          - description: The action can't be perfomed in the current object's state.
            name: UnacceptableState
          - description: The object that you are trying to access does not exist on the cloud.
            name: ObjectNotFoundOnCloud
          - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid.
            name: UnacceptableObjectConfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse_2'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse_2'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse_2'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse_2'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse_2'
      tags:
      - Webhook Endpoints
components:
  schemas:
    WebhookEndpointListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/WebhookEndpoint'
          readOnly: true
          type: array
        errors:
          items:
            $ref: '#/components/schemas/ApiMessage'
          readOnly: true
          type: array
        meta:
          $ref: '#/components/schemas/ApiMetaContainer'
          readOnly: true
        pagination:
          $ref: '#/components/schemas/ApiPagination'
          readOnly: true
        warnings:
          items:
            $ref: '#/components/schemas/ApiMessage'
          readOnly: true
          type: array
      x-derived:
        $ref: '#/components/schemas/WebhookEndpoint'
      x-usedIn:
      - /account/{accountId}/webhook-endpoints/
    WebhookEndpoint_2:
      description: Webhook endpoint summary.
      properties:
        id:
          description: Webhook endpoint identifier.
          maxLength: 36
          minLength: 36
          pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
          type: string
        scope:
          enum:
          - scalr
          - account
          - environment
          - farm
          - farmrole
          - role
          - server
          type: string
        url:
          description: Endpoint URL.
          type: string
    ApiMessage:
      properties:
        code:
          description: A machine-readable representation of the message.
          type: string
        message:
          description: A human-readable representation of the message.
          type: string
    ApiErrorResponse_2:
      description: Common response for erroneous requests.
      properties:
        errors:
          items:
            $ref: '#/components/schemas/ApiMessage'
          readOnly: true
          type: array
        meta:
          $ref: '#/components/schemas/ApiMetaContainer'
          readOnly: true
        warnings:
          items:
            $ref: '#/components/schemas/ApiMessage'
          readOnly: true
          type: array
      x-usedIn:
      - /user/{envId}/global-variables/
      - /user/{envId}/global-variables/{globalVariableName}/
      - /user/{envId}/orchestration-rules/
      - /user/{envId}/orchestration-rules/{orchestrationRuleId}/
      - /user/{envId}/projects/
      - /user/{envId}/projects/{projectId}/
      - /user/{envId}/cost-centers/
      - /user/{envId}/cost-centers/{costCenterId}/
      - /user/{envId}/role-categories/
      - /user/{envId}/role-categories/{roleCategoryId}/
      - /user/{envId}/roles/
      - /user/{envId}/roles/{roleId}/
      - /user/{envId}/roles/{roleId}/actions/promote/
      - /user/{envId}/roles/{roleId}/actions/clone/
      - /user/{envId}/roles/{roleId}/actions/deprecate/
      - /user/{envId}/roles/{roleId}/images/
      - /user/{envId}/roles/{roleId}/images/{imageId}/
      - /user/{envId}/roles/{roleId}/images/{imageId}/actions/replace/
      - /user/{envId}/roles/{roleId}/global-variables/
      - /user/{envId}/roles/{roleId}/global-variables/{globalVariableName}/
      - /user/{envId}/roles/{roleId}/orchestration-rules/
      - /user/{envId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
      - /user/{envId}/images/
      - /user/{envId}/images/{imageId}/
      - /user/{envId}/images/{imageId}/actions/copy/
      - /user/{envId}/images/{imageId}/actions/replace/
      - /user/{envId}/servers/
      - /user/{envId}/servers/{serverId}/
      - /user/{envId}/servers/{serverId}/actions/suspend/
      - /user/{envId}/servers/{serverId}/actions/terminate/
      - /user/{envId}/servers/{serverId}/actions/resume/
      - /user/{envId}/servers/{serverId}/actions/reboot/
      - /user/{envId}/servers/{serverId}/actions/sync/
      - /user/{envId}/servers/{serverId}/global-variables/
      - /user/{envId}/servers/{serverId}/global-variables/{globalVariableName}/
      - /user/{envId}/farms/{farmId}/servers/
      - /user/{envId}/farm-roles/{farmRoleId}/servers/
      - /user/{envId}/scripts/
      - /user/{envId}/scripts/{scriptId}/
      - /user/{envId}/scripts/{scriptId}/actions/execute/
      - /user/{envId}/scripts/{scriptId}/script-versions/
      - /user/{envId}/scripts/{scriptId}/script-versions/{scriptVersionNumber}/
      - /user/{envId}/scripts/{scriptId}/script-versions/{scriptVersionNumber}/actions/execute/
      - /user/{envId}/script-executions/{scriptExecutionId}/
      - /user/{envId}/orchestration-logs/
      - /user/{envId}/orchestration-logs/{logEntryId}/
      - /user/{envId}/event-logs/
      - /user/{envId}/event-logs/{eventLogEntryId}/
      - /user/{envId}/webhook-endpoints/
      - /user/{envId}/os/
      - /user/{envId}/os/{osId}/
      - /user/{envId}/events/
      - /user/{envId}/events/{eventId}/
      - /user/{envId}/events/{eventId}/actions/fire/
      - /user/{envId}/farms/
      - /user/{envId}/farms/{farmId}/
      - /user/{envId}/farms/{farmId}/cloud-services/
      - /user/{envId}/farms/{farmId}/cloud-services/{farmCloudServiceLinkId}/
      - /user/{envId}/farms/{farmId}/actions/generate-template/
      - /user/{envId}/farms/{farmId}/actions/launch/
      - /user/{envId}/farms/{farmId}/actions/suspend/
      - /user/{envId}/farms/{farmId}/actions/resume/
      - /user/{envId}/farms/{farmId}/actions/terminate/
      - /user/{envId}/farms/{farmId}/actions/lock/
      - /user/{envId}/farms/{farmId}/actions/unlock/
      - /user/{envId}/farms/{farmId}/actions/clone/
      - /user/{envId}/farms/{farmId}/global-variables/
      - /user/{envId}/farms/{farmId}/global-variables/{globalVariableName}/
      - /user/{envId}/farms/{farmId}/farm-roles/
      - /user/{envId}/farm-roles/{farmRoleId}/
      - /user/{envId}/farm-roles/{farmRoleId}/actions/import-server/
      - /user/{envId}/farm-roles/{farmRoleId}/actions/generate-template/
      - /user/{envId}/farm-roles/{farmRoleId}/actions/clone/
      - /user/{envId}/farm-roles/{farmRoleId}/scaling/
      - /user/{envId}/farm-roles/{farmRoleId}/scaling/{metricName}/
      - /user/{envId}/farm-roles/{farmRoleId}/storage/
      - /user/{envId}/farm-roles/{farmRoleId}/storage/{storageConfigurationId}/
      - /user/{envId}/scaling-metrics/
      - /user/{envId}/scaling-metrics/{metricName}/
      - /user/{envId}/farm-roles/{farmRoleId}/global-variables/
      - /user/{envId}/farm-roles/{farmRoleId}/global-variables/{globalVariableName}/
      - /user/{envId}/farm-roles/{farmRoleId}/orchestration-rules/
      - /user/{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/
      - /user/{envId}/clouds/{cloudPlatform}/cloud-locations/
      - /user/{envId}/clouds/{cloudPlatform}/cloud-locations/{cloudLocation}/instance-types/
    WebhookEndpoint:
      description: Webhook endpoint summary.
      properties:
        id:
          description: Identifier of the Webhook endpoint.
          maxLength: 36
          minLength: 36
          pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
          type: string
        scope:
          enum:
          - scalr
          - account
          - environment
          - farm
          - farmrole
          - role
          - server
          type: string
        url:
          description: Endpoint URL.
          type: string
    ApiPagination:
      properties:
        first:
          readOnly: true
          type: string
        last:
          readOnly: true
          type: string
        next:
          readOnly: true
          type: string
        prev:
          readOnly: true
          type: string
    ApiErrorResponse:
      description: Common response for erroneous requests.
      properties:
        errors:
          items:
            $ref: '#/components/schemas/ApiMessage'
          readOnly: true
          type: array
        meta:
          $ref: '#/components/schemas/ApiMetaContainer'
          readOnly: true
        warnings:
          items:
            $ref: '#/components/schemas/ApiMessage'
          readOnly: true
          type: array
      x-usedIn:
      - /account/{accountId}/global-variables/
      - /account/{accountId}/global-variables/{globalVariableName}/
      - /account/{accountId}/orchestration-rules/
      - /account/{accountId}/orchestration-rules/{orchestrationRuleId}/
      - /account/{accountId}/cost-centers/
      - /account/{accountId}/cost-centers/{costCenterId}/
      - /account/{accountId}/environments/
      - /account/{accountId}/environments/{envId}/
      - /account/{accountId}/environments/{envId}/clouds/
      - /account/{accountId}/environments/{envId}/clouds/{cloud}/
      - /account/{accountId}/environments/{envId}/teams/
      - /account/{accountId}/environments/{envId}/teams/{teamId}/
      - /account/{accountId}/teams/
      - /account/{accountId}/teams/{teamId}/
      - /account/{accountId}/acl-roles/
      - /account/{accountId}/role-categories/
      - /account/{accountId}/role-categories/{roleCategoryId}/
      - /account/{accountId}/roles/
      - /account/{accountId}/roles/{roleId}/
      - /account/{accountId}/roles/{roleId}/actions/clone/
      - /account/{accountId}/roles/{roleId}/actions/deprecate/
      - /account/{accountId}/roles/{roleId}/images/
      - /account/{accountId}/roles/{roleId}/images/{imageId}/
      - /account/{accountId}/roles/{roleId}/images/{imageId}/actions/replace/
      - /account/{accountId}/roles/{roleId}/global-variables/
      - /account/{accountId}/roles/{roleId}/global-variables/{globalVariableName}/
      - /account/{accountId}/roles/{roleId}/orchestration-rules/
      - /account/{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
      - /account/{accountId}/images/
      - /account/{accountId}/images/{imageId}/
      - /account/{accountId}/images/{imageId}/actions/copy/
      - /account/{accountId}/images/{imageId}/actions/replace/
      - /account/{accountId}/projects/
      - /account/{accountId}/projects/{projectId}/
      - /account/{accountId}/scripts/
      - /account/{accountId}/scripts/{scriptId}/
      - /account/{accountId}/scripts/{scriptId}/script-versions/
      - /account/{accountId}/scripts/{scriptId}/script-versions/{scriptVersionNumber}/
      - /account/{accountId}/webhook-endpoints/
      - /account/{accountId}/os/
      - /account/{accountId}/os/{osId}/
      - /account/{accountId}/events/
      - /account/{accountId}/events/{eventId}/
      - /account/{accountId}/cloud-credentials/
      - /account/{accountId}/cloud-credentials/{cloudCredentialsId}/
      - /account/{accountId}/scaling-metrics/
      - /account/{accountId}/scaling-metrics/{metricName}/
      - /account/{accountId}/users/
      - /account/{accountId}/ansible-tower/servers/
      - /account/{accountId}/ansible-tower/configurations/
      - /account/{accountId}/ansible-tower/configurations/{ansibleTowerConfigurationId}/
    WebhookEndpointListResponse_2:
      properties:
        data:
          items:
            $ref: '#/components/schemas/WebhookEndpoint_2'
          readOnly: true
          type: array
        errors:
          items:
            $ref: '#/components/schemas/ApiMessage'
          readOnly: true
          type: array
        meta:
          $ref: '#/components/schemas/ApiMetaContainer'
          readOnly: true
        pagination:
          $ref: '#/components/schemas/ApiPagination'
          readOnly: true
        warnings:
          items:
            $ref: '#/components/schemas/ApiMessage'
          readOnly: true
          type: array
      x-derived:
        $ref: '#/components/schemas/WebhookEndpoint_2'
      x-usedIn:
      - /user/{envId}/webhook-endpoints/
    ApiMetaContainer:
      properties:
        sample:
          description: Actual properties TBD.
          type: string
x-dry-yaml-definitions:
  architecture:
    enum:
    - i386
    - x86_64
    type: string
  cloudLocationProperties:
    cloudLocation:
      description: 'Cloud Location, inside a given Cloud Platform, for this resource. May be null if this resource does not have a specific location. Note: if you would like to filter on this property, you **must** also filter on `cloudPlatform`.'
      type: string
    cloudPlatform:
      description: The Cloud Platform this resource resides in.
      enum:
      - ec2
      - gce
      type: string
  cloudstackProvider:
    description: Cloud provider that should be specified for CloudStack based clouds.
    enum:
    - cloudstack
    - idcf
    type: string
  openstackProvider:
    description: Cloud provider that should be specified for OpenStack based clouds.
    enum:
    - openstack
    - ocs
    - hpcloud
    - mirantis
    - vio
    - cisco
    type: string
  pathParamsPatterns:
    uuid:
      maxLength: 36
      minLength: 36
      pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
    uuidShort:
      maxLength: 12
      minLength: 12
      pattern: '[A-Fa-f0-9]+'
  scopeProperty:
    enum:
    - scalr
    - account
    - environment
    - farm
    - farmrole
    - role
    - server
    type: string