Scalr Events API
The Events API from Scalr — 5 operation(s) for events.
OpenAPI Specification
swagger: '2.0'
info:
description: Manage Roles, Images, Environments and etc.
title: Scalr Account Acl Roles Events API
version: 1.0.0
basePath: /api/v1beta0/account
produces:
- application/json
tags:
- name: Events
paths:
/{accountId}/events/:
parameters:
- description: The ID of the Account scoping this request.
in: path
name: accountId
required: true
type: integer
get:
description: List all the Events available in this Account.
responses:
200:
description: A list of Event objects.
schema:
$ref: '#/definitions/EventListResponse'
400:
description: A client-side error was made.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
401:
description: The request was not authenticated.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: The request was not properly authenticated.
name: BadAuthentication
403:
description: Insufficient permissions.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
404:
description: Resource not found.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
409:
description: Conflict with current state.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
422:
description: This request was well-formed but was rejected due to semantic errors.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: Some of the configuration settings cannot be applied because they conflict with the current state.
name: ConfigurationMismatch
500:
description: A server-side error occurred.
schema:
$ref: '#/definitions/ApiErrorResponse'
501:
description: This feature is not implemented in Scalr.
schema:
$ref: '#/definitions/ApiErrorResponse'
503:
description: The service is currently unavailable.
schema:
$ref: '#/definitions/ApiErrorResponse'
tags:
- Events
post:
description: Create a new Custom Event in this Account.
parameters:
- description: The JSON representation of a Event object.
in: body
name: eventObject
required: true
schema:
$ref: '#/definitions/Event'
- description: Replace all Events declared at a lower scope with the same name with this one.
in: query
name: replace
required: false
type: boolean
responses:
201:
description: The JSON representation of a Event object.
schema:
$ref: '#/definitions/EventDetailsResponse'
400:
description: A client-side error was made.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
401:
description: The request was not authenticated.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: The request was not properly authenticated.
name: BadAuthentication
403:
description: Insufficient permissions.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
404:
description: Resource not found.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
409:
description: Conflict with current state.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
422:
description: This request was well-formed but was rejected due to semantic errors.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: Some of the configuration settings cannot be applied because they conflict with the current state.
name: ConfigurationMismatch
500:
description: A server-side error occurred.
schema:
$ref: '#/definitions/ApiErrorResponse'
501:
description: This feature is not implemented in Scalr.
schema:
$ref: '#/definitions/ApiErrorResponse'
503:
description: The service is currently unavailable.
schema:
$ref: '#/definitions/ApiErrorResponse'
tags:
- Events
/{accountId}/events/{eventId}/:
parameters:
- description: The ID of the Account scoping this request.
in: path
name: accountId
required: true
type: integer
- description: The ID of a Event object.
in: path
maxLength: 25
name: eventId
pattern: '[A-Za-z0-9]+'
required: true
type: string
x-references:
$ref: '#/definitions/Event'
delete:
description: Delete a given Event from this Account.
responses:
204:
description: Successful deletion.
400:
description: A client-side error was made.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
401:
description: The request was not authenticated.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: The request was not properly authenticated.
name: BadAuthentication
403:
description: Insufficient permissions.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
404:
description: Resource not found.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
409:
description: Conflict with current state.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
422:
description: This request was well-formed but was rejected due to semantic errors.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: Some of the configuration settings cannot be applied because they conflict with the current state.
name: ConfigurationMismatch
500:
description: A server-side error occurred.
schema:
$ref: '#/definitions/ApiErrorResponse'
501:
description: This feature is not implemented in Scalr.
schema:
$ref: '#/definitions/ApiErrorResponse'
503:
description: The service is currently unavailable.
schema:
$ref: '#/definitions/ApiErrorResponse'
tags:
- Events
get:
description: Retrieve detailed information about a given Event.
responses:
200:
description: The JSON representation of a Event object.
schema:
$ref: '#/definitions/EventDetailsResponse'
400:
description: A client-side error was made.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
401:
description: The request was not authenticated.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: The request was not properly authenticated.
name: BadAuthentication
403:
description: Insufficient permissions.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
404:
description: Resource not found.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
409:
description: Conflict with current state.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
422:
description: This request was well-formed but was rejected due to semantic errors.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: Some of the configuration settings cannot be applied because they conflict with the current state.
name: ConfigurationMismatch
500:
description: A server-side error occurred.
schema:
$ref: '#/definitions/ApiErrorResponse'
501:
description: This feature is not implemented in Scalr.
schema:
$ref: '#/definitions/ApiErrorResponse'
503:
description: The service is currently unavailable.
schema:
$ref: '#/definitions/ApiErrorResponse'
tags:
- Events
patch:
description: Modify the attributes of a given Event.
parameters:
- description: The JSON representation of a Event object.
in: body
name: eventObject
required: true
schema:
$ref: '#/definitions/Event'
responses:
200:
description: The JSON representation of a Event object.
schema:
$ref: '#/definitions/EventDetailsResponse'
400:
description: A client-side error was made.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
401:
description: The request was not authenticated.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: The request was not properly authenticated.
name: BadAuthentication
403:
description: Insufficient permissions.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
404:
description: Resource not found.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
409:
description: Conflict with current state.
schema:
$ref: '#/definitions/ApiErrorResponse'
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
422:
description: This request was well-formed but was rejected due to semantic errors.
schema:
$ref: '#/definitions/ApiErrorResponse'
x-errorCodes:
- description: Some of the configuration settings cannot be applied because they conflict with the current state.
name: ConfigurationMismatch
500:
description: A server-side error occurred.
schema:
$ref: '#/definitions/ApiErrorResponse'
501:
description: This feature is not implemented in Scalr.
schema:
$ref: '#/definitions/ApiErrorResponse'
503:
description: The service is currently unavailable.
schema:
$ref: '#/definitions/ApiErrorResponse'
tags:
- Events
/{envId}/events/:
parameters:
- description: The ID of the Environment scoping this request.
in: path
name: envId
required: true
type: integer
get:
description: List all the Events available in this Environment.
responses:
200:
description: A list of Event objects.
schema:
$ref: '#/definitions/EventListResponse_2'
400:
description: A client-side error was made.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
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
401:
description: The request was not authenticated.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
x-errorCodes:
- description: The request was not properly authenticated.
name: BadAuthentication
403:
description: Insufficient permissions.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
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
404:
description: Resource not found.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
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
409:
description: Conflict with current state.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
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
422:
description: This request was well-formed but was rejected due to semantic errors.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
x-errorCodes:
- description: Some of the configuration settings cannot be applied because they conflict with the current state.
name: ConfigurationMismatch
500:
description: A server-side error occurred.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
501:
description: This feature is not implemented in Scalr.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
503:
description: The service is currently unavailable.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
tags:
- Events
post:
description: Create a new Custom Event in this Environment.
parameters:
- description: The JSON representation of a Event object.
in: body
name: eventObject
required: true
schema:
$ref: '#/definitions/Event_2'
responses:
201:
description: The JSON representation of a Event object.
schema:
$ref: '#/definitions/EventDetailsResponse_2'
400:
description: A client-side error was made.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
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
401:
description: The request was not authenticated.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
x-errorCodes:
- description: The request was not properly authenticated.
name: BadAuthentication
403:
description: Insufficient permissions.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
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
404:
description: Resource not found.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
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
409:
description: Conflict with current state.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
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
422:
description: This request was well-formed but was rejected due to semantic errors.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
x-errorCodes:
- description: Some of the configuration settings cannot be applied because they conflict with the current state.
name: ConfigurationMismatch
500:
description: A server-side error occurred.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
501:
description: This feature is not implemented in Scalr.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
503:
description: The service is currently unavailable.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
tags:
- Events
/{envId}/events/{eventId}/:
parameters:
- description: The ID of the Environment scoping this request.
in: path
name: envId
required: true
type: integer
- description: The ID of a Event object.
in: path
maxLength: 25
name: eventId
pattern: '[A-Za-z0-9]+'
required: true
type: string
x-references:
$ref: '#/definitions/Event_2'
delete:
description: Delete an Event from this Environment.
responses:
204:
description: Successful deletion.
400:
description: A client-side error was made.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
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
401:
description: The request was not authenticated.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
x-errorCodes:
- description: The request was not properly authenticated.
name: BadAuthentication
403:
description: Insufficient permissions.
schema:
$ref: '#/definitions/ApiErrorResponse_2'
x-errorCodes:
- description: This request should be made in a different Scope.
name: S
# --- truncated at 32 KB (126 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scalr/refs/heads/main/openapi/scalr-events-api-openapi.yml