swagger: '2.0' info: description: Manage Roles, Images, Environments and etc. title: Scalr Account Acl Roles Orchestration Rules API version: 1.0.0 basePath: /api/v1beta0/account produces: - application/json tags: - name: Orchestration Rules paths: /{accountId}/orchestration-rules/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer get: description: List the Orchestration Rules in this Account. responses: 200: description: A list of OrchestrationRule objects. schema: $ref: '#/definitions/OrchestrationRuleListResponse' 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: - Orchestration Rules post: description: Create a new Orchestration Rule for this Account. parameters: - description: The JSON representation of a OrchestrationRule object. in: body name: orchestrationRuleObject required: true schema: $ref: '#/definitions/OrchestrationRule' responses: 201: description: The JSON representation of a OrchestrationRule object. schema: $ref: '#/definitions/OrchestrationRuleDetailsResponse' 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: - Orchestration Rules /{accountId}/orchestration-rules/{orchestrationRuleId}/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer - description: The ID of a OrchestrationRule object. in: path maxLength: 36 minLength: 36 name: orchestrationRuleId 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/OrchestrationRule' delete: description: Delete an Orchestration Rule from this Account. responses: 204: description: Successful deletion. 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse' x-errorCodes: - description: The request was structurally incorrect, and was not understood by the API. name: InvalidStructure - description: The request was understood by the API, but included invalid data. name: InvalidValue - description: The request wasn't understood by the API. name: BadRequest 401: description: The request was not authenticated. schema: $ref: '#/definitions/ApiErrorResponse' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse' x-errorCodes: - description: This request should be made in a different Scope. name: ScopeViolation - description: You do not have the necessary permissions to perform this request. name: PermissionViolation - description: The maximum memory limit in GB has been reached. name: MemoryQuotaExceeded - description: The vCPUs limit has been reached. name: VcpusQuotaExceeded - description: The maximum number of the Servers that you can launch or resume has been reached. name: ServersQuotaExceeded - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached. name: ServersPerFarmQuotaExceeded 404: description: Resource not found. schema: $ref: '#/definitions/ApiErrorResponse' x-errorCodes: - description: This endpoint does not exist. name: EndpointNotFound noDoc: true - description: The object you are trying to access does not exist. name: ObjectNotFound 409: description: Conflict with current state. schema: $ref: '#/definitions/ApiErrorResponse' x-errorCodes: - description: These changes aren't possible while this object is in use. name: ObjectInUse - description: These changes would violate a policy. name: PolicyViolation - description: These changes would violate a unicity constraint. name: UnicityViolation - description: Some of the objects being changed are locked and cannot be changed. name: Locked - description: This Cloud platform is not enabled. name: NotEnabledPlatform - description: The Operating System does not match. name: OperatingSystemMismatch - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid. name: UnacceptableObjectConfiguration 422: description: This request was well-formed but was rejected due to semantic errors. schema: $ref: '#/definitions/ApiErrorResponse' x-errorCodes: - description: Some of the configuration settings cannot be applied because they conflict with the current state. name: ConfigurationMismatch 500: description: A server-side error occurred. schema: $ref: '#/definitions/ApiErrorResponse' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse' tags: - Orchestration Rules get: description: Retrieve detailed information about a given Orchestration Rule. responses: 200: description: The JSON representation of a OrchestrationRule object. schema: $ref: '#/definitions/OrchestrationRuleDetailsResponse' 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: - Orchestration Rules patch: description: Modify an Orchestration Rule. parameters: - description: The JSON representation of a OrchestrationRule object. in: body name: orchestrationRuleObject required: true schema: $ref: '#/definitions/OrchestrationRule' responses: 200: description: The JSON representation of a OrchestrationRule object. schema: $ref: '#/definitions/OrchestrationRuleDetailsResponse' 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: - Orchestration Rules /{envId}/orchestration-rules/: parameters: - description: The ID of the Environment scoping this request. in: path name: envId required: true type: integer get: description: List the Orchestration Rules in this Environment. responses: 200: description: A list of OrchestrationRule objects. schema: $ref: '#/definitions/OrchestrationRuleListResponse_2' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was structurally incorrect, and was not understood by the API. name: InvalidStructure - description: The request was understood by the API, but included invalid data. name: InvalidValue - description: The request wasn't understood by the API. name: BadRequest 401: description: The request was not authenticated. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This request should be made in a different Scope. name: ScopeViolation - description: You do not have the necessary permissions to perform this request. name: PermissionViolation - description: The maximum memory limit in GB has been reached. name: MemoryQuotaExceeded - description: The vCPUs limit has been reached. name: VcpusQuotaExceeded - description: The maximum number of the Servers that you can launch or resume has been reached. name: ServersQuotaExceeded - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached. name: ServersPerFarmQuotaExceeded 404: description: Resource not found. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This endpoint does not exist. name: EndpointNotFound noDoc: true - description: The object you are trying to access does not exist. name: ObjectNotFound 409: description: Conflict with current state. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: These changes aren't possible while this object is in use. name: ObjectInUse - description: These changes would violate a policy. name: PolicyViolation - description: These changes would violate a unicity constraint. name: UnicityViolation - description: Some of the objects being changed are locked and cannot be changed. name: Locked - description: This Cloud platform is not enabled. name: NotEnabledPlatform - description: The Operating System does not match. name: OperatingSystemMismatch - description: Some of the objects or actions being access are deprecated. name: Deprecated - description: The action can't be perfomed in the current object's state. name: UnacceptableState - description: The object that you are trying to access does not exist on the cloud. name: ObjectNotFoundOnCloud - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid. name: UnacceptableObjectConfiguration 422: description: This request was well-formed but was rejected due to semantic errors. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: Some of the configuration settings cannot be applied because they conflict with the current state. name: ConfigurationMismatch 500: description: A server-side error occurred. schema: $ref: '#/definitions/ApiErrorResponse_2' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_2' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_2' tags: - Orchestration Rules post: description: Create a new Orchestration Rule for this Environment. parameters: - description: The JSON representation of a OrchestrationRule object. in: body name: orchestrationRuleObject required: true schema: $ref: '#/definitions/OrchestrationRule_2' responses: 201: description: The JSON representation of a OrchestrationRule object. schema: $ref: '#/definitions/OrchestrationRuleDetailsResponse_2' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was structurally incorrect, and was not understood by the API. name: InvalidStructure - description: The request was understood by the API, but included invalid data. name: InvalidValue - description: The request wasn't understood by the API. name: BadRequest 401: description: The request was not authenticated. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This request should be made in a different Scope. name: ScopeViolation - description: You do not have the necessary permissions to perform this request. name: PermissionViolation - description: The maximum memory limit in GB has been reached. name: MemoryQuotaExceeded - description: The vCPUs limit has been reached. name: VcpusQuotaExceeded - description: The maximum number of the Servers that you can launch or resume has been reached. name: ServersQuotaExceeded - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached. name: ServersPerFarmQuotaExceeded 404: description: Resource not found. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This endpoint does not exist. name: EndpointNotFound noDoc: true - description: The object you are trying to access does not exist. name: ObjectNotFound 409: description: Conflict with current state. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: These changes aren't possible while this object is in use. name: ObjectInUse - description: These changes would violate a policy. name: PolicyViolation - description: These changes would violate a unicity constraint. name: UnicityViolation - description: Some of the objects being changed are locked and cannot be changed. name: Locked - description: This Cloud platform is not enabled. name: NotEnabledPlatform - description: The Operating System does not match. name: OperatingSystemMismatch - description: Some of the objects or actions being access are deprecated. name: Deprecated - description: The action can't be perfomed in the current object's state. name: UnacceptableState - description: The object that you are trying to access does not exist on the cloud. name: ObjectNotFoundOnCloud - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid. name: UnacceptableObjectConfiguration 422: description: This request was well-formed but was rejected due to semantic errors. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: Some of the configuration settings cannot be applied because they conflict with the current state. name: ConfigurationMismatch 500: description: A server-side error occurred. schema: $ref: '#/definitions/ApiErrorResponse_2' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_2' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_2' tags: - Orchestration Rules /{envId}/orchestration-rules/{orchestrationRuleId}/: parameters: - description: The ID of the Environment scoping this request. in: path name: envId required: true type: integer - description: The ID of a OrchestrationRule object. in: path maxLength: 36 minLength: 36 name: orchestrationRuleId 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/OrchestrationRule_2' delete: description: Delete an Orchestration Rule from this Environment. responses: 204: description: Successful deletion. 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was structurally incorrect, and was not understood by the API. name: InvalidStructure - description: The request was understood by the API, but included invalid data. name: InvalidValue - description: The request wasn't understood by the API. name: BadRequest 401: description: The request was not authenticated. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This request should be made in a different Scope. name: ScopeViolation - description: You do not have the necessary permissions to perform this request. name: PermissionViolation - description: The maximum memory limit in GB has been reached. name: MemoryQuotaExceeded - description: The vCPUs limit has been reached. name: VcpusQuotaExceeded - description: The maximum number of the Servers that you can launch or resume has been reached. name: ServersQuotaExceeded - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached. name: ServersPerFarmQuotaExceeded 404: description: Resource not found. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This endpoint does not exist. name: EndpointNotFound noDoc: true - description: The object you are trying to access does not exist. name: ObjectNotFound 409: description: Conflict with current state. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: These changes aren't possible while this object is in use. name: ObjectInUse - description: These changes would violate a policy. name: PolicyViolation - description: These changes would violate a unicity constraint. name: UnicityViolation - description: Some of the objects being changed are locked and cannot be changed. name: Locked - description: This Cloud platform is not enabled. name: NotEnabledPlatform - description: The Operating System does not match. name: OperatingSystemMismatch - description: Some of the objects or actions being access are deprecated. name: Deprecated - description: The action can't be perfomed in the current object's state. name: UnacceptableState - description: The object that you are trying to access does not exist on the cloud. name: ObjectNotFoundOnCloud - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid. name: UnacceptableObjectConfiguration 422: description: This request was well-formed but was rejected due to semantic errors. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: Some of the configuration settings cannot be applied because they conflict with the current state. name: ConfigurationMismatch 500: description: A server-side error occurred. schema: $ref: '#/definitions/ApiErrorResponse_2' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_2' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_2' tags: - Orchestration Rules get: description: Retrieve detailed information about a given Orchestration Rule. responses: 200: description: The JSON representation of a OrchestrationRule object. schema: $ref: '#/definitions/OrchestrationRuleDetailsResponse_2' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was structurally incorrect, and was not understood by the API. name: InvalidStructure - description: The request was understood by the API, but included invalid data. name: InvalidValue - description: The request wasn't understood by the API. name: BadRequest 401: description: The request was not authenticated. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This request should be made in a different Scope. name: ScopeViolation - description: You do not have the necessary permissions to perform this request. name: PermissionViolation - description: The maximum memory limit in GB has been reached. name: MemoryQuotaExceeded - description: The vCPUs limit has been reached. name: VcpusQuotaExceeded - description: The maximum number of the Servers that you can launch or resume has been reached. name: ServersQuotaExceeded - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached. name: ServersPerFarmQuotaExceeded 404: description: Resource not found. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This endpoint does not exist. name: EndpointNotFound noDoc: true - description: The object you are trying to access does not exist. name: ObjectNotFound 409: description: Conflict with current state. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: These changes aren't possible while this object is in use. name: ObjectInUse - description: These changes would violate a policy. name: PolicyViolation - description: These changes would violate a unicity constraint. name: UnicityViolation - description: Some of the objects being changed are locked and cannot be changed. name: Locked - description: This Cloud platform is not enabled. name: NotEnabledPlatform - description: The Operating System does not match. name: OperatingSystemMismatch - description: Some of the objects or actions being access are deprecated. name: Deprecated - description: The action can't be perfomed in the current object's state. name: UnacceptableState - description: The object that you are trying to access does not exist on the cloud. name: ObjectNotFoundOnCloud - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid. name: UnacceptableObjectConfiguration 422: description: This request was well-formed but was rejected due to semantic errors. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: Some of the configuration settings cannot be applied because they conflict with the current state. name: ConfigurationMismatch 500: description: A server-side error occurred. schema: $ref: '#/definitions/ApiErrorResponse_2' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_2' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_2' tags: - Orchestration Rules patch: description: Modify an Orchestration Rule. parameters: - description: The JSON representation of a OrchestrationRule object. in: body name: orchestrationRuleObject required: true schema: $ref: '#/definitions/OrchestrationRule_2' responses: 200: description: The JSON representation of a OrchestrationRule object. schema: $ref: '#/definitions/OrchestrationRuleDetailsResponse_2' 400: description: A client-side error was made. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was structurally incorrect, and was not understood by the API. name: InvalidStructure - description: The request was understood by the API, but included invalid data. name: InvalidValue - description: The request wasn't understood by the API. name: BadRequest 401: description: The request was not authenticated. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: The request was not properly authenticated. name: BadAuthentication 403: description: Insufficient permissions. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This request should be made in a different Scope. name: ScopeViolation - description: You do not have the necessary permissions to perform this request. name: PermissionViolation - description: The maximum memory limit in GB has been reached. name: MemoryQuotaExceeded - description: The vCPUs limit has been reached. name: VcpusQuotaExceeded - description: The maximum number of the Servers that you can launch or resume has been reached. name: ServersQuotaExceeded - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached. name: ServersPerFarmQuotaExceeded 404: description: Resource not found. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: This endpoint does not exist. name: EndpointNotFound noDoc: true - description: The object you are trying to access does not exist. name: ObjectNotFound 409: description: Conflict with current state. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: These changes aren't possible while this object is in use. name: ObjectInUse - description: These changes would violate a policy. name: PolicyViolation - description: These changes would violate a unicity constraint. name: UnicityViolation - description: Some of the objects being changed are locked and cannot be changed. name: Locked - description: This Cloud platform is not enabled. name: NotEnabledPlatform - description: The Operating System does not match. name: OperatingSystemMismatch - description: Some of the objects or actions being access are deprecated. name: Deprecated - description: The action can't be perfomed in the current object's state. name: UnacceptableState - description: The object that you are trying to access does not exist on the cloud. name: ObjectNotFoundOnCloud - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid. name: UnacceptableObjectConfiguration 422: description: This request was well-formed but was rejected due to semantic errors. schema: $ref: '#/definitions/ApiErrorResponse_2' x-errorCodes: - description: Some of the configuration settings cannot be applied because they conflict with the current state. name: ConfigurationMismatch 500: description: A server-side error occurred. schema: $ref: '#/definitions/ApiErrorResponse_2' 501: description: This feature is not implemented in Scalr. schema: $ref: '#/definitions/ApiErrorResponse_2' 503: description: The service is currently unavailable. schema: $ref: '#/definitions/ApiErrorResponse_2' tags: - Orchestration Rules definitions: OrchestrationRuleCondition: discriminator: type properties: type: description: Orchestration rule condition type. Selected only those servers that match conditions. enum: - FarmRolesCondition - OsCondition - TagsCondition type: string required: - type x-concreteTypes: - $ref: '#/definitions/FarmRolesCondition' - $ref: '#/definitions/OsCondition' - $ref: '#/definitions/TagsCondition' Action: discriminator: actionType properties: actionType: enum: - ScalrScriptAction - RemoteScriptAction - ChefAction - LocalScriptAction - AnsibleTowerAction type: string required: - actionType x-concreteTypes: - $ref: '#/definitions/AnsibleTowerAction' - $ref: '#/definitions/ScalrScriptAction' - $ref: '#/definitions/RemoteScriptAction' - $ref: '#/definitions/LocalScriptAction' - $ref: '#/definitions/ChefAction' OsCondition: properties: osType: description: OS family or type. type: string type: description: Orchestration rule condition type. Selected only those servers that match conditions. enum: - FarmRolesCondition - OsCondition - TagsCondition type: string required: - type - osType x-abstractType: $ref: '#/definitions/OrchestrationRuleCondition' x-discriminator: type ScriptVariableRemoteList: properties: category: description: The category of this Variable. type: string description: description: A description that explains what this Global Variable is used for. type: string hidden: description: Whether this Script Variable is hidden in Orchestration Rules or execute Script action. type: boolean integrationEndpoint: $ref: '#/definitions/WebhookEndpointForeignKey' locked: description: Whether this Script Variable value is locked in Orchestration Rules or execute Script action. type: boolean name: description: The Variable name. type: string required: description: Whether this Script Variable value is required in Orchestration Rules or execute Script action. type: boolean type: description: The type of Script Variable. enum: - ScriptVariableJson - ScriptVariableString - ScriptVariableList - ScriptVariableRemoteList type: string value: description: The value declared in the script level. This property can be redefined for not locked variables in Orhestration Rules or execute Script action. Also this field supports Global Variable interpolation. type: string required: - name - type - integrationEndpoint x-abstractType: $ref: '#/definitions/ScriptVariable' x-createOnly: - name x-discriminator: type AnsibleTowerAction: properties: actionType: enum: - ScalrScriptAction - RemoteScriptAction - ChefAction - LocalScriptAction - AnsibleTowerAction type: string configuration: $ref: '#/definitions/AnsibleTowerConfigurationIdentity' description: Ansible Tower identity stored at Bootstrap Configurations. jobTemplate: $ref: '#/definitions/JobTemplateIdentity' description: Ansible Tower Job template stored at Tower Server. variables: description: The Ansible Tower variables to override. JSON or YAML representation. type: string required: - actionType - configuration - jobTemplate x-abstractType: $ref: '#/definitions/Action' x-discriminator: actionType FarmTarget: description: Selects all the Servers that belong to the triggering Server's Farm. properties: conditions: description: 'Triggering servers conditions. ' items: $ref: '#/definitions/OrchestrationRuleCondition' type: array targetType: enum: - TriggeringServerTarget - TriggeringFarmRoleTarget - FarmTarget type: string required: - targetType x-abstractType: $ref: '#/definitions/Target' x-discriminator: targetType OrchestrationRule_2: properties: action: $ref: '#/definitions/Action_2' description: Orchestration Rule action that will be executed on the target servers. blocking: description: Whether this Orchestration Rule's execution should delay the execution of further Orchestration Rules and the triggering of further Events. Defaults to the action's default when null. type: boolean enabled: default: true description: If Orchestration Rule is not enabled this Rule won't be triggered type: boolean id: description: Unique identifier for an Orchestration Rule. 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 order: description: The priority of this Orchestration Rule relative to other Orchestration Rules that use the same triggeringEvent. Default is relative to existing Rules. type: integer runAs: description: A name of the system user the Orchestration Rule should be executed as. Administrator / root is used by default. type: string scope: enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string target: $ref: '#/definitions/Target' description: The set of Servers where the Orchestration Rules Action will be executed. timeout: description: The time Scalr should wait for before aborting the execution of this Orchestration Rule, in seconds. Defaults to the action's default when null. type: integer trigger: $ref: '#/definitions/Trigger' description: Orchestration Rule trigger. required: - trigger - action - target x-filterable: - id - blocking - order - runAs x-usedIn: - /user/{envId}/orchestration-rules/ - /user/{envId}/orchestration-rules/{orchestrationRuleId}/ - /user/{envId}/roles/{roleId}/orchestration-rules/ - /user/{envId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/ - /user/{envId}/farm-roles/{farmRoleId}/orchestration-rules/ - /user/{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/ AllEventsTrigger: description: Triggers when any Event fires. properties: triggerType: enum: - AllEventsTrigger - SpecificEventTrigger type: string required: - triggerType x-abstractType: $ref: '#/definitions/Trigger' x-discriminator: triggerType TriggeringServerTarget: description: Select only the Server that triggered the Event. properties: conditions: description: 'Triggering servers conditions. ' items: $ref: '#/definitions/OrchestrationRuleCondition' type: array targetType: enum: - TriggeringServerTarget - TriggeringFarmRoleTarget - FarmTarget type: string required: - targetType x-abstractType: $ref: '#/definitions/Target' x-discriminator: targetType ApiPagination: properties: first: readOnly: true type: string last: readOnly: true type: string next: readOnly: true type: string prev: readOnly: true type: string FarmRoleIdentity: properties: alias: description: The Alias for this Farm Role. type: string id: description: Unique identifier for this Farm Role. readOnly: true type: integer Trigger: discriminator: triggerType properties: triggerType: enum: - AllEventsTrigger - SpecificEventTrigger type: string required: - triggerType x-concreteTypes: - $ref: '#/definitions/AllEventsTrigger' - $ref: '#/definitions/SpecificEventTrigger' AnsibleTowerConfigurationIdentity: properties: id: description: The Ansible Tower configuration identifier. maxLength: 36 minLength: 36 pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' type: string name: description: The Ansible Tower configuration name. type: string 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}/ OrchestrationRuleListResponse: properties: data: items: $ref: '#/definitions/OrchestrationRule' 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/OrchestrationRule' x-usedIn: - /account/{accountId}/orchestration-rules/ - /account/{accountId}/roles/{roleId}/orchestration-rules/ LocalScriptAction: properties: actionType: enum: - ScalrScriptAction - RemoteScriptAction - ChefAction - LocalScriptAction - AnsibleTowerAction type: string path: description: Path to the script to execute. type: string required: - actionType - path x-abstractType: $ref: '#/definitions/Action' x-discriminator: actionType WebhookEndpoint: description: Webhook endpoint summary. properties: id: description: Identifier of the Webhook endpoint. maxLength: 36 minLength: 36 pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}' type: string scope: enum: - scalr - account - environment - farm - farmrole - role - server type: string url: description: Endpoint URL. type: string ApiMetaContainer: properties: sample: description: Actual properties TBD. type: string ScriptVariable: discriminator: type properties: category: description: The category of this Variable. type: string description: description: A description that explains what this Global Variable is used for. type: string hidden: description: Whether this Script Variable is hidden in Orchestration Rules or execute Script action. type: boolean locked: description: Whether this Script Variable value is locked in Orchestration Rules or execute Script action. type: boolean name: description: The Variable name. type: string required: description: Whether this Script Variable value is required in Orchestration Rules or execute Script action. type: boolean type: description: The type of Script Variable. enum: - ScriptVariableJson - ScriptVariableString - ScriptVariableList - ScriptVariableRemoteList type: string value: description: The value declared in the script level. This property can be redefined for not locked variables in Orhestration Rules or execute Script action. Also this field supports Global Variable interpolation. type: string required: - name - type x-concreteTypes: - $ref: '#/definitions/ScriptVariableString' - $ref: '#/definitions/ScriptVariableJson' - $ref: '#/definitions/ScriptVariableList' - $ref: '#/definitions/ScriptVariableRemoteList' x-createOnly: - name ScriptIdentity: properties: id: type: integer name: description: The name of the Script. type: string required: - id x-derived: $ref: '#/definitions/Script' x-references: $ref: '#/definitions/Script' FarmRolesCondition: properties: farmRoles: description: Farm Role identity objects. items: $ref: '#/definitions/FarmRoleIdentity' type: array type: description: Orchestration rule condition type. Selected only those servers that match conditions. enum: - FarmRolesCondition - OsCondition - TagsCondition type: string required: - type x-abstractType: $ref: '#/definitions/OrchestrationRuleCondition' x-discriminator: type ScriptVariableString: properties: category: description: The category of this Variable. type: string description: description: A description that explains what this Global Variable is used for. type: string hidden: description: Whether this Script Variable is hidden in Orchestration Rules or execute Script action. type: boolean locked: description: Whether this Script Variable value is locked in Orchestration Rules or execute Script action. type: boolean name: description: The Variable name. type: string outputFormat: description: The formatting to apply when displaying this variable. type: string required: description: Whether this Script Variable value is required in Orchestration Rules or execute Script action. type: boolean type: description: The type of Script Variable. enum: - ScriptVariableJson - ScriptVariableString - ScriptVariableList - ScriptVariableRemoteList type: string validationPattern: description: The validation regular expresion to validate the value. type: string value: description: The value declared in the script level. This property can be redefined for not locked variables in Orhestration Rules or execute Script action. Also this field supports Global Variable interpolation. type: string required: - name - type x-abstractType: $ref: '#/definitions/ScriptVariable' x-createOnly: - name x-discriminator: type ScalrScriptAction: properties: actionType: enum: - ScalrScriptAction - RemoteScriptAction - ChefAction - LocalScriptAction - AnsibleTowerAction type: string scriptVersion: $ref: '#/definitions/ScriptVersionIdentity' description: ScriptVersion to execute. required: - actionType - scriptVersion x-abstractType: $ref: '#/definitions/Action' x-discriminator: actionType VariableAllowedValue: properties: label: description: The Global Variable Value label type: string value: description: The Global Variable value type: string required: - value TriggeringFarmRoleTarget: description: Selects all the Servers that belong to the same Farm Role as the Server that triggered the Event. properties: targetType: enum: - TriggeringServerTarget - TriggeringFarmRoleTarget - FarmTarget type: string required: - targetType x-abstractType: $ref: '#/definitions/Target' x-discriminator: targetType OrchestrationRule: properties: action: $ref: '#/definitions/Action' description: Orchestration Rule action that will be executed on the target servers. blocking: description: Whether this Orchestration Rule's execution should delay the execution of further Orchestration Rules and the triggering of further Events. Defaults to the action's default when null. type: boolean enabled: default: true description: If Orchestration Rule is not enabled this Rule won't be triggered. type: boolean id: description: Unique identifier for an Orchestration Rule. 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 order: description: The priority of this Orchestration Rule relative to other Orchestration Rules that use the same triggeringEvent. Default is relative to existing Rules. type: integer runAs: description: User the Orchestration Rule should execute as. Defaults to root / Administrator when null. type: string scope: enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string target: $ref: '#/definitions/Target' description: The set of Servers where the Orchestration Rules Action will be executed. timeout: description: The time Scalr should wait for before aborting the execution of this Orchestration Rule, in seconds. Defaults to the action's default when null. type: integer trigger: $ref: '#/definitions/Trigger' description: Orchestration Rule trigger. required: - trigger - action - target x-filterable: - id - blocking - order - runAs x-usedIn: - /account/{accountId}/orchestration-rules/ - /account/{accountId}/orchestration-rules/{orchestrationRuleId}/ - /account/{accountId}/roles/{roleId}/orchestration-rules/ - /account/{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/ Script: properties: added: format: date-time readOnly: true type: string blockingDefault: description: Whether this Script is blocking by default. This can be overridden in the Orchestration Rules that use this Script. type: boolean deprecated: default: false description: Whether the Script is deprecated. type: boolean description: type: string id: readOnly: true type: integer lastChanged: format: date-time readOnly: true type: string name: description: The name of the Script. type: string osType: description: Type of OS this Script should execute on. This will influence Orchestration Rules, and will impact the validation rules applied to the ScriptVersions. enum: - linux - windows - cross-platform type: string requireAdminPrivileges: default: false description: Whether the Script requires root/Administrator privileges to be executed. type: boolean scope: enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string tags: description: The list of tags that should be applied to the Script. items: type: string type: array timeoutDefault: description: The time after which Scalr will abort the execution of this Script, in seconds. This can be overridden in the Orchestration Rules that use this Script. type: integer variables: description: The list of redefined script variables for the current script. items: $ref: '#/definitions/ScriptVariable' type: array required: - name - osType x-createOnly: - osType x-filterable: - id - name - osType - blockingDefault - scope - deprecated - requireAdminPrivileges x-usedIn: - /account/{accountId}/scripts/ - /account/{accountId}/scripts/{scriptId}/ - /account/{accountId}/scripts/{scriptId}/script-versions/ - /account/{accountId}/scripts/{scriptId}/script-versions/{scriptVersionNumber}/ Action_2: discriminator: actionType properties: actionType: enum: - ScalrScriptAction - RemoteScriptAction - ChefAction - LocalScriptAction - AnsibleTowerAction type: string required: - actionType x-concreteTypes: - $ref: '#/definitions/ScalrScriptAction' - $ref: '#/definitions/RemoteScriptAction_2' - $ref: '#/definitions/LocalScriptAction' - $ref: '#/definitions/ChefAction' - $ref: '#/definitions/AnsibleTowerAction' RemoteScriptAction_2: properties: actionType: enum: - ScalrScriptAction - RemoteScriptAction - ChefAction - LocalScriptAction - AnsibleTowerAction type: string path: description: URL to the script to execute. type: string required: - actionType - path x-abstractType: $ref: '#/definitions/Action_2' x-discriminator: actionType ScriptVersionIdentity: properties: script: $ref: '#/definitions/ScriptIdentity' variables: description: The list of redefined script variables for the current script. items: $ref: '#/definitions/ScriptVariableValue' type: array version: description: The Script version. null is interpreted as the latest/default Version. type: string Target: discriminator: targetType properties: targetType: enum: - TriggeringServerTarget - TriggeringFarmRoleTarget - FarmTarget type: string required: - targetType x-concreteTypes: - $ref: '#/definitions/TriggeringServerTarget' - $ref: '#/definitions/TriggeringFarmRoleTarget' - $ref: '#/definitions/FarmTarget' Event: properties: description: type: string id: description: The name of this Custom Event. maxLength: 25 pattern: '[A-Za-z0-9]+' type: string scope: enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string required: - id x-createOnly: - id x-filterable: - id - scope x-usedIn: - /account/{accountId}/events/ - /account/{accountId}/events/{eventId}/ OrchestrationRuleListResponse_2: properties: data: items: $ref: '#/definitions/OrchestrationRule_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/OrchestrationRule_2' x-usedIn: - /user/{envId}/orchestration-rules/ - /user/{envId}/roles/{roleId}/orchestration-rules/ - /user/{envId}/farm-roles/{farmRoleId}/orchestration-rules/ ApiMessage: properties: code: description: A machine-readable representation of the message. type: string message: description: A human-readable representation of the message. type: string SpecificEventTrigger: description: Triggers when a specific Event fires. properties: event: $ref: '#/definitions/EventForeignKey' triggerType: enum: - AllEventsTrigger - SpecificEventTrigger type: string required: - triggerType - event x-abstractType: $ref: '#/definitions/Trigger' x-discriminator: triggerType RemoteScriptAction: properties: actionType: enum: - ScalrScriptAction - RemoteScriptAction - ChefAction - LocalScriptAction - AnsibleTowerAction type: string path: description: Path or URL to the script to execute. type: string required: - actionType - path x-abstractType: $ref: '#/definitions/Action' x-discriminator: actionType ChefAction: properties: actionType: enum: - ScalrScriptAction - RemoteScriptAction - ChefAction - LocalScriptAction - AnsibleTowerAction type: string required: - actionType x-abstractType: $ref: '#/definitions/Action' x-discriminator: actionType OrchestrationRuleDetailsResponse_2: properties: data: $ref: '#/definitions/OrchestrationRule_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/OrchestrationRule_2' x-usedIn: - /user/{envId}/orchestration-rules/ - /user/{envId}/orchestration-rules/{orchestrationRuleId}/ - /user/{envId}/roles/{roleId}/orchestration-rules/ - /user/{envId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/ - /user/{envId}/farm-roles/{farmRoleId}/orchestration-rules/ - /user/{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/ 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: - /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/ ScriptVariableJson: properties: category: description: The category of this Variable. type: string description: description: A description that explains what this Global Variable is used for. type: string hidden: description: Whether this Script Variable is hidden in Orchestration Rules or execute Script action. type: boolean locked: description: Whether this Script Variable value is locked in Orchestration Rules or execute Script action. type: boolean name: description: The Variable name. type: string required: description: Whether this Script Variable value is required in Orchestration Rules or execute Script action. type: boolean type: description: The type of Script Variable. enum: - ScriptVariableJson - ScriptVariableString - ScriptVariableList - ScriptVariableRemoteList type: string value: description: The value declared in the script level. This property can be redefined for not locked variables in Orhestration Rules or execute Script action. Also this field supports Global Variable interpolation. type: string required: - name - type x-abstractType: $ref: '#/definitions/ScriptVariable' x-createOnly: - name x-discriminator: type JobTemplateIdentity: properties: id: description: The Ansible Tower Job template identifier. type: integer name: description: The Ansible Tower Job template name. type: string scmBranch: description: The Ansible Tower Job template SCM Branch. type: string TagsCondition: properties: tags: description: Selects all the Servers that belong to the Role with at least one tag from this list. items: type: string type: array type: description: Orchestration rule condition type. Selected only those servers that match conditions. enum: - FarmRolesCondition - OsCondition - TagsCondition type: string required: - type - tags x-abstractType: $ref: '#/definitions/OrchestrationRuleCondition' x-discriminator: type ScriptVariableValue: properties: name: description: The Variable name. type: string value: description: The redefined value declared in the Script level. type: string required: - name WebhookEndpointForeignKey: properties: id: description: Webhook endpoint identifier. type: string required: - id x-derived: $ref: '#/definitions/WebhookEndpoint' x-references: $ref: '#/definitions/WebhookEndpoint' OrchestrationRuleDetailsResponse: properties: data: $ref: '#/definitions/OrchestrationRule' 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/OrchestrationRule' x-usedIn: - /account/{accountId}/orchestration-rules/ - /account/{accountId}/orchestration-rules/{orchestrationRuleId}/ - /account/{accountId}/roles/{roleId}/orchestration-rules/ - /account/{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/ ScriptVariableList: properties: allowedValues: description: The list of values to which the Global Variable value must correspond. items: $ref: '#/definitions/VariableAllowedValue' type: array category: description: The category of this Variable. type: string description: description: A description that explains what this Global Variable is used for. type: string hidden: description: Whether this Script Variable is hidden in Orchestration Rules or execute Script action. type: boolean locked: description: Whether this Script Variable value is locked in Orchestration Rules or execute Script action. type: boolean name: description: The Variable name. type: string required: description: Whether this Script Variable value is required in Orchestration Rules or execute Script action. type: boolean type: description: The type of Script Variable. enum: - ScriptVariableJson - ScriptVariableString - ScriptVariableList - ScriptVariableRemoteList type: string value: description: The value declared in the script level. This property can be redefined for not locked variables in Orhestration Rules or execute Script action. Also this field supports Global Variable interpolation. type: string required: - name - type - allowedValues x-abstractType: $ref: '#/definitions/ScriptVariable' x-createOnly: - name x-discriminator: type EventForeignKey: properties: id: description: The name of this Custom Event. type: string required: - id x-derived: $ref: '#/definitions/Event' x-references: $ref: '#/definitions/Event' 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