swagger: '2.0' info: description: Manage Roles, Images, Environments and etc. title: Scalr Account Acl Roles Images API version: 1.0.0 basePath: /api/v1beta0/account produces: - application/json tags: - name: Images paths: /{accountId}/images/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer get: description: List all the Images available in this Account. responses: 200: description: A list of Image objects. schema: $ref: '#/definitions/ImageListResponse' 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: - Images post: description: Register a new Image in this Account. parameters: - description: The JSON representation of a Image object. in: body name: imageObject required: true schema: $ref: '#/definitions/Image' responses: 201: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse' 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: - Images /{accountId}/images/{imageId}/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer - description: The ID of a Image object. in: path maxLength: 36 minLength: 36 name: imageId pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' required: true type: string x-references: $ref: '#/definitions/Image' delete: description: Remove an Image from this Account. This does not remove the underlying machine image from the Cloud it resides in. 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: - Images get: description: Retrieve detailed information about an image. responses: 200: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse' 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: - Images patch: description: Modify the attributes of an Image. Currently only the name of the Image can be changed. parameters: - description: The updated definition. in: body name: image required: true schema: $ref: '#/definitions/Image' responses: 200: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse' 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: - Images /{accountId}/images/{imageId}/actions/copy/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer - description: The ID of a Image object. in: path maxLength: 36 minLength: 36 name: imageId pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' required: true type: string x-references: $ref: '#/definitions/Image' post: description: Copy an Image from one EC2 region to another. parameters: - description: Copy Image options. in: body name: copyImageRequest required: true schema: properties: cloudCredentials: $ref: '#/definitions/CloudCredentialsForeignKey' cloudLocation: description: The EC2 destination region where this Image will be copied. type: string required: - cloudLocation - cloudCredentials responses: 201: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse' 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: - Images /{accountId}/images/{imageId}/actions/replace/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer - description: The identifier of the old Image object. in: path maxLength: 36 minLength: 36 name: imageId pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' required: true type: string x-references: $ref: '#/definitions/Image' post: description: Replace the current Image with a specified one for all Roles which use this Image. parameters: - description: Replace image options. in: body name: replaceImageRequest required: true schema: properties: deprecateOldImage: default: false description: If the value is true Scalr will mark old Image as deprecated. type: boolean newImage: $ref: '#/definitions/ImageForeignKey' description: The identifier of a new Image object. scope: default: - account description: Make a replacement for all Roles from the selected scopes. If you choose to make a replacement including lower scope you must also choose higher scope values. items: enum: - account - environment type: string type: array required: - newImage responses: 200: description: A list of RoleScopeIdentity objects. schema: $ref: '#/definitions/RoleScopeIdentityListResponse' 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: - Images /images/: get: description: List all the Images available in the global scope. responses: 200: description: A list of Image objects. schema: $ref: '#/definitions/ImageListResponse_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 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: - Images post: description: Register a new Image in the global scope. parameters: - description: The JSON representation of a Image object. in: body name: imageObject required: true schema: $ref: '#/definitions/Image_2' responses: 201: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse_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 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: - Images /images/{imageId}/: parameters: - description: The ID of a Image object. in: path maxLength: 36 minLength: 36 name: imageId pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' required: true type: string x-references: $ref: '#/definitions/Image_2' delete: description: Deregisters an Image from the global scope. 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: 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 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: - Images get: description: Retrieve detailed information about an Image. responses: 200: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse_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 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: - Images patch: description: Modify the attributes of an Image. Currently only the name of the Image can be changed. parameters: - description: The updated definition. in: body name: image required: true schema: $ref: '#/definitions/Image_2' responses: 200: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse_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 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: - Images /images/{imageId}/actions/copy/: parameters: - description: The ID of a Image object. in: path maxLength: 36 minLength: 36 name: imageId pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' required: true type: string x-references: $ref: '#/definitions/Image_2' post: description: Copy an Image from one EC2 region to another. parameters: - description: Copy Image options. in: body name: copyImageRequest required: true schema: properties: cloudCredentials: $ref: '#/definitions/CloudCredentialsForeignKey_2' cloudLocation: description: The EC2 destination region where this Image will be copied. type: string required: - cloudLocation - cloudCredentials responses: 201: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse_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 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: - Images /images/{imageId}/actions/replace/: parameters: - description: The identifier of the old Image object. in: path maxLength: 36 minLength: 36 name: imageId pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' required: true type: string x-references: $ref: '#/definitions/Image_2' post: description: Replace the current Image with a specified one for all Roles which use this Image. parameters: - description: Replace image options. in: body name: replaceImageRequest required: true schema: properties: deprecateOldImage: default: false description: If the value is true Scalr will mark source Image as deprecated. type: boolean newImage: $ref: '#/definitions/ImageForeignKey' description: The identifier of a new Image object. scope: default: - scalr description: Make a replacement for all Roles from the selected scopes. If you choose to make a replacement including lower scope you must also choose higher scope values. items: enum: - scalr - account - environment type: string type: array required: - newImage responses: 200: description: A list of RoleScopeIdentity objects. schema: $ref: '#/definitions/RoleScopeIdentityListResponse_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 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: - Images /{envId}/images/: parameters: - description: The ID of the Environment scoping this request. in: path name: envId required: true type: integer get: description: List all the Images available in the Environment. responses: 200: description: A list of Image objects. schema: $ref: '#/definitions/ImageListResponse_3' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' 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_3' 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_3' 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_3' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_3' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_3' tags: - Images post: description: Register a new Image in this Environment. parameters: - description: The JSON representation of a Image object. in: body name: imageObject required: true schema: $ref: '#/definitions/Image_3' responses: 201: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse_3' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' 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_3' 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_3' 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_3' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_3' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_3' tags: - Images /{envId}/images/{imageId}/: parameters: - description: The ID of the Environment scoping this request. in: path name: envId required: true type: integer - description: The ID of a Image object. in: path maxLength: 36 minLength: 36 name: imageId pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' required: true type: string x-references: $ref: '#/definitions/Image_3' delete: description: Remove an Image from the Environment. By default this does not delete the underlying machine image from the Cloud it resides in. parameters: - description: Attempt to also delete this Image from the Cloud. in: query name: deleteFromCloud required: false type: boolean responses: 202: description: Image scheduled for deregistration and deletion from cloud. 204: description: Successful deletion. 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' 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_3' 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_3' 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_3' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_3' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_3' tags: - Images get: description: Retrieve detailed information about an Image. responses: 200: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse_3' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' 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_3' 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_3' 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_3' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_3' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_3' tags: - Images patch: description: Modify the attributes of an Images. Currently only the name of the Image be can changed. parameters: - description: The updated definition. in: body name: image required: true schema: $ref: '#/definitions/Image_3' responses: 200: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse_3' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' 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_3' 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_3' 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_3' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_3' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_3' tags: - Images /{envId}/images/{imageId}/actions/copy/: parameters: - description: The ID of the Environment scoping this request. in: path name: envId required: true type: integer - description: The ID of a Image object. in: path maxLength: 36 minLength: 36 name: imageId pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' required: true type: string x-references: $ref: '#/definitions/Image_3' post: description: Copy an Image from one EC2 region to another. parameters: - description: The EC2 region to copy this Image to. in: body name: copyImageRequest required: true schema: $ref: '#/definitions/CloudLocation' responses: 201: description: The JSON representation of a Image object. schema: $ref: '#/definitions/ImageDetailsResponse_3' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' 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_3' 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_3' 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_3' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_3' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_3' tags: - Images /{envId}/images/{imageId}/actions/replace/: parameters: - description: The ID of the Environment scoping this request. in: path name: envId required: true type: integer - description: The identifier of the old Image object. in: path maxLength: 36 minLength: 36 name: imageId pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' required: true type: string x-references: $ref: '#/definitions/Image_3' post: description: Replace the current Image with a specified one for all Roles which use this Image. The Image will be replaced only within the Environment scope. parameters: - description: Replace image options. in: body name: replaceImageRequest required: true schema: properties: deprecateOldImage: default: false description: If the value is true Scalr will mark old Image as deprecated. type: boolean newImage: $ref: '#/definitions/ImageForeignKey' description: The identifier of a new Image object. required: - newImage responses: 200: description: A list of RoleScopeIdentity objects. schema: $ref: '#/definitions/RoleScopeIdentityListResponse_3' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_3' 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_3' 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_3' 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_3' 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_3' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_3' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_3' tags: - Images definitions: RoleScopeIdentityListResponse: properties: data: items: $ref: '#/definitions/RoleScopeIdentity' readOnly: true type: array errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true pagination: $ref: '#/definitions/ApiPagination' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-derived: $ref: '#/definitions/RoleScopeIdentity' x-usedIn: - /account/{accountId}/images/{imageId}/actions/replace/ Os: properties: family: description: OS family. type: string generation: type: string id: description: An ID uniquely identifying this OS in Scalr. pattern: '[A-Za-z0-9-]+' type: string name: description: A human-readable name for this OS. type: string version: type: string required: - id - name - family - generation - version x-filterable: - id - name - family - generation x-usedIn: - /account/{accountId}/os/{osId}/ CloudLocation: properties: 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 required: - cloudPlatform x-usedIn: - /user/{envId}/images/{imageId}/actions/copy/ ApiPagination: properties: first: readOnly: true type: string last: readOnly: true type: string next: readOnly: true type: string prev: readOnly: true type: string OpenstackImageCloudFeatures: description: Cloud specifics Image configuration. properties: sourceType: default: image description: The Openstack image source type. Set shapshot for image based on volume shapshot. enum: - image - snapshot type: string type: enum: - AwsImageCloudFeatures - VmwareImageCloudFeatures - OpenstackImageCloudFeatures type: string required: - type x-abstractType: $ref: '#/definitions/ImageCloudFeatures' x-discriminator: type RoleScopeIdentityListResponse_2: properties: data: items: $ref: '#/definitions/RoleScopeIdentity' readOnly: true type: array errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true pagination: $ref: '#/definitions/ApiPagination' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-derived: $ref: '#/definitions/RoleScopeIdentity' x-usedIn: - /global/images/{imageId}/actions/replace/ ApiErrorResponse_3: description: Common response for erroneous requests. properties: errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true warnings: items: $ref: '#/definitions/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/ ApiErrorResponse: description: Common response for erroneous requests. properties: errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true warnings: items: $ref: '#/definitions/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}/ Image: properties: added: description: Date and time at which this Image was created. format: date-time readOnly: true type: string architecture: enum: - i386 - x86_64 type: string cloudFeatures: $ref: '#/definitions/ImageCloudFeatures' cloudImageId: type: string cloudInitInstalled: description: Whether cloud-init is installed on this Image. type: boolean 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 deprecated: description: Whether this Image is deprecated. type: boolean id: maxLength: 36 minLength: 36 pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' readOnly: true type: string lastUsed: description: Date and time at which this Image was last used. format: date-time readOnly: true type: string name: type: string os: $ref: '#/definitions/OsForeignKey' scalrAgentInstalled: description: Whether Scalr Agent is installed on this Image. type: boolean scope: enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string size: description: Size of the image in GB. This property is read-only at the Environment scope. type: integer source: description: Indicates how this Image was created. enum: - Manual - BundleTask readOnly: true type: string status: description: Current status for this Image. `failed` means that the deletion failed. enum: - active - pending_delete - failed readOnly: true type: string statusError: description: If the Image is in a failed state, this indicates why. readOnly: true type: string type: description: (Only used on EC2 currently) Whether this Image is HVM or EBS. At the Environment scope this property is read-only. Property is deprecated and will be removed soon. Use 'cloudFeatures' instead. type: string required: - name - cloudPlatform - cloudImageId - architecture - os x-createOnly: - cloudImageId - size - type - scalrAgentInstalled - cloudInitInstalled - cloudLocation - cloudPlatform - os - architecture - cloudFeatures x-filterable: - id - name - scope - cloudPlatform - cloudLocation - cloudImageId - architecture - source - status - deprecated - os - scalrAgentInstalled - cloudInitInstalled x-usedIn: - /account/{accountId}/roles/{roleId}/images/{imageId}/ - /account/{accountId}/roles/{roleId}/images/{imageId}/actions/replace/ - /account/{accountId}/images/ - /account/{accountId}/images/{imageId}/ - /account/{accountId}/images/{imageId}/actions/copy/ - /account/{accountId}/images/{imageId}/actions/replace/ VmwareImageCloudFeatures: description: Cloud specifics Image configuration. properties: type: enum: - AwsImageCloudFeatures - VmwareImageCloudFeatures - OpenstackImageCloudFeatures type: string vCenterHost: description: The vCenter host where the current Image exists. At the Environment scope this property is read-only. type: string required: - type x-abstractType: $ref: '#/definitions/ImageCloudFeatures' x-discriminator: type ImageDetailsResponse_2: properties: data: $ref: '#/definitions/Image_2' readOnly: true errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-derived: $ref: '#/definitions/Image_2' x-usedIn: - /global/roles/{roleId}/images/{imageId}/ - /global/images/ - /global/images/{imageId}/ - /global/images/{imageId}/actions/copy/ ApiMetaContainer: properties: sample: description: Actual properties TBD. type: string AwsImageCloudFeatures: description: Cloud specifics Image configuration. properties: accountId: description: AWS account ID type: string type: enum: - AwsImageCloudFeatures - VmwareImageCloudFeatures - OpenstackImageCloudFeatures type: string virtualization: description: 'The Image virtualization type. Can be one of two types of virtualization: paravirtual (pv) or hardware virtual machine (hvm). At the Environment scope this property is read-only.' enum: - hvm - paravirtual type: string required: - type x-abstractType: $ref: '#/definitions/ImageCloudFeatures' x-discriminator: type ImageDetailsResponse: properties: data: $ref: '#/definitions/Image' readOnly: true errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-derived: $ref: '#/definitions/Image' x-usedIn: - /account/{accountId}/roles/{roleId}/images/{imageId}/ - /account/{accountId}/images/ - /account/{accountId}/images/{imageId}/ - /account/{accountId}/images/{imageId}/actions/copy/ ImageListResponse_2: properties: data: items: $ref: '#/definitions/Image_2' readOnly: true type: array errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true pagination: $ref: '#/definitions/ApiPagination' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-derived: $ref: '#/definitions/Image_2' x-usedIn: - /global/images/ ImageForeignKey: properties: id: type: string required: - id x-derived: $ref: '#/definitions/Image' x-references: $ref: '#/definitions/Image' OsForeignKey: properties: id: description: An ID uniquely identifying this OS in Scalr. type: string required: - id x-derived: $ref: '#/definitions/Os' x-references: $ref: '#/definitions/Os' CloudCredentialsForeignKey: properties: id: description: Unique identifier of a Cloud Credentials object. type: string required: - id x-usedIn: - /account/{accountId}/environments/{envId}/clouds/{cloud}/ ImageListResponse_3: properties: data: items: $ref: '#/definitions/Image_3' readOnly: true type: array errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true pagination: $ref: '#/definitions/ApiPagination' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-derived: $ref: '#/definitions/Image_3' x-usedIn: - /user/{envId}/images/ CloudCredentialsForeignKey_2: properties: id: description: Unique identifier of Cloud Credentials object. type: string required: - id RoleScopeIdentity: description: The Role Scope identity relation. properties: accountId: description: Account identifier. readOnly: true type: integer envId: description: Environment identifier. readOnly: true type: integer id: description: Identifier of the Role. readOnly: true type: integer scope: enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true 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 Image_2: properties: added: description: Date and time at which this Image was created. format: date-time readOnly: true type: string architecture: enum: - i386 - x86_64 type: string cloudFeatures: $ref: '#/definitions/ImageCloudFeatures' cloudImageId: type: string cloudInitInstalled: description: Whether cloud-init is installed on this Image. type: boolean 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 - azure - cloudstack - idcf - openstack - ocs - otc - rackspacenguk - rackspacengus - hpcloud - mirantis - vio - cisco - vmware type: string deprecated: description: Whether this Image is deprecated. type: boolean id: maxLength: 36 minLength: 36 pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' readOnly: true type: string lastUsed: description: Date and time at which this Image was last used. format: date-time readOnly: true type: string name: type: string os: $ref: '#/definitions/OsForeignKey' scalrAgentInstalled: description: Whether Scalr Agent is installed on this Image. type: boolean scope: enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string size: description: Size of the image in GB. This property is read-only at the Environment scope. type: integer source: description: Indicates how this Image was created. enum: - Manual - BundleTask readOnly: true type: string status: description: Current status for this Image. `failed` means that the deletion failed. enum: - active - pending_delete - failed readOnly: true type: string statusError: description: If the Image is in a failed state, this indicates why. readOnly: true type: string type: description: (Only used on EC2 currently) Whether this Image is HVM or EBS. At the Environment scope this property is read-only. Property is deprecated and will be removed soon. Use 'cloudFeatures' instead. type: string required: - name - cloudPlatform - cloudImageId - architecture - os x-createOnly: - cloudImageId - size - type - scalrAgentInstalled - cloudInitInstalled - cloudLocation - cloudPlatform - os - architecture - cloudFeatures x-filterable: - id - name - scope - cloudPlatform - cloudLocation - cloudImageId - architecture - source - status - deprecated - os - scalrAgentInstalled - cloudInitInstalled x-usedIn: - /global/roles/{roleId}/images/{imageId}/ - /global/roles/{roleId}/images/{imageId}/actions/replace/ - /global/images/ - /global/images/{imageId}/ - /global/images/{imageId}/actions/copy/ - /global/images/{imageId}/actions/replace/ Image_3: properties: added: description: Date and time at which this Image was created. format: date-time readOnly: true type: string architecture: enum: - i386 - x86_64 type: string cloudFeatures: $ref: '#/definitions/ImageCloudFeatures' cloudImageId: type: string cloudInitInstalled: description: Whether cloud-init is installed on this Image. type: boolean 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 deprecated: description: Whether this Image is deprecated. type: boolean id: maxLength: 36 minLength: 36 pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' readOnly: true type: string lastUsed: description: Date and time at which this Image was last used. format: date-time readOnly: true type: string name: type: string os: $ref: '#/definitions/OsForeignKey' scalrAgentInstalled: description: Whether Scalr Agent is installed on this Image. type: boolean scope: enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string size: description: Size of the image in GB. This property is read-only at the Environment scope. type: integer source: description: Indicates how this Image was created. enum: - Manual - BundleTask readOnly: true type: string status: description: Current status for this Image. `failed` means that the deletion failed. enum: - active - pending_delete - failed readOnly: true type: string statusError: description: If the Image is in a failed state, this indicates why. readOnly: true type: string type: description: (Only used on EC2 currently) Whether this Image is HVM or EBS. At the Environment scope this property is read-only. Property is deprecated and will be removed soon. Use 'cloudFeatures' instead. type: string required: - name - cloudPlatform - cloudImageId - architecture - os x-createOnly: - cloudImageId - size - type - scalrAgentInstalled - cloudInitInstalled - cloudLocation - cloudPlatform - os - architecture - cloudFeatures x-filterable: - id - name - scope - cloudPlatform - cloudLocation - cloudImageId - architecture - source - status - deprecated - os - scalrAgentInstalled - cloudInitInstalled x-usedIn: - /user/{envId}/roles/{roleId}/images/{imageId}/ - /user/{envId}/roles/{roleId}/images/{imageId}/actions/replace/ - /user/{envId}/images/ - /user/{envId}/images/{imageId}/ - /user/{envId}/images/{imageId}/actions/copy/ - /user/{envId}/images/{imageId}/actions/replace/ ImageCloudFeatures: description: Cloud specifics Image configuration. discriminator: type properties: type: enum: - AwsImageCloudFeatures - VmwareImageCloudFeatures - OpenstackImageCloudFeatures type: string required: - type x-concreteTypes: - $ref: '#/definitions/AwsImageCloudFeatures' - $ref: '#/definitions/VmwareImageCloudFeatures' - $ref: '#/definitions/OpenstackImageCloudFeatures' ApiErrorResponse_2: description: Common response for erroneous requests. properties: errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-usedIn: - /global/global-variables/ - /global/global-variables/{globalVariableName}/ - /global/role-categories/ - /global/role-categories/{roleCategoryId}/ - /global/roles/ - /global/roles/{roleId}/ - /global/roles/{roleId}/actions/deprecate/ - /global/roles/{roleId}/images/ - /global/roles/{roleId}/images/{imageId}/ - /global/roles/{roleId}/images/{imageId}/actions/replace/ - /global/roles/{roleId}/global-variables/ - /global/roles/{roleId}/global-variables/{globalVariableName}/ - /global/roles/{roleId}/orchestration-rules/ - /global/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/ - /global/images/ - /global/images/{imageId}/ - /global/images/{imageId}/actions/copy/ - /global/images/{imageId}/actions/replace/ - /global/os/ - /global/os/{osId}/ - /global/projects/ - /global/projects/{projectId}/ - /global/cloud-credentials/ - /global/cloud-credentials/{cloudCredentialsId}/ - /global/users/ - /global/ansible-tower/servers/ - /global/ansible-tower/configurations/ - /global/ansible-tower/configurations/{ansibleTowerConfigurationId}/ ImageDetailsResponse_3: properties: data: $ref: '#/definitions/Image_3' readOnly: true errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-derived: $ref: '#/definitions/Image_3' x-usedIn: - /user/{envId}/roles/{roleId}/images/{imageId}/ - /user/{envId}/images/ - /user/{envId}/images/{imageId}/ - /user/{envId}/images/{imageId}/actions/copy/ ImageListResponse: properties: data: items: $ref: '#/definitions/Image' readOnly: true type: array errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true pagination: $ref: '#/definitions/ApiPagination' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-derived: $ref: '#/definitions/Image' x-usedIn: - /account/{accountId}/images/ RoleScopeIdentityListResponse_3: properties: data: items: $ref: '#/definitions/RoleScopeIdentity' readOnly: true type: array errors: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array meta: $ref: '#/definitions/ApiMetaContainer' readOnly: true pagination: $ref: '#/definitions/ApiPagination' readOnly: true warnings: items: $ref: '#/definitions/ApiMessage' readOnly: true type: array x-derived: $ref: '#/definitions/RoleScopeIdentity' x-usedIn: - /user/{envId}/images/{imageId}/actions/replace/ 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