swagger: '2.0' info: description: Manage Roles, Images, Environments and etc. title: Scalr Account Acl Roles Environments API version: 1.0.0 basePath: /api/v1beta0/account produces: - application/json tags: - name: Environments paths: /{accountId}/environments/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer get: description: List Environments available in this Account. responses: 200: description: A list of Environment objects. schema: $ref: '#/definitions/EnvironmentListResponse' 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: - Environments post: description: Create a new Environment in the Account. parameters: - description: The JSON representation of a Environment object. in: body name: environmentObject required: true schema: $ref: '#/definitions/Environment' responses: 201: description: The JSON representation of a Environment object. schema: $ref: '#/definitions/EnvironmentDetailsResponse' 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: - Environments /{accountId}/environments/{envId}/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer - description: The ID of the Environment being accessed. in: path name: envId required: true type: integer delete: description: Delete an Environment from the 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: - Environments get: description: Retrieve detailed information about a given Environment. responses: 200: description: The JSON representation of a Environment object. schema: $ref: '#/definitions/EnvironmentDetailsResponse' 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: - Environments patch: description: Update the attributes of an Environment. parameters: - description: The JSON representation of a Environment object. in: body name: environmentObject required: true schema: $ref: '#/definitions/Environment' responses: 200: description: The JSON representation of a Environment object. schema: $ref: '#/definitions/EnvironmentDetailsResponse' 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: - Environments /{accountId}/environments/{envId}/clouds/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer - description: The ID of the Environment being accessed. in: path name: envId required: true type: integer get: description: List the Clouds this environment has access to. responses: 200: description: A list of Cloud objects. schema: $ref: '#/definitions/CloudListResponse' 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: - Environments /{accountId}/environments/{envId}/clouds/{cloud}/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer - description: The ID of the Environment being accessed. in: path name: envId required: true type: integer - description: The name of the cloud. in: path name: cloud pattern: \w+ required: true type: string delete: description: Detaches Cloud Credentials from this Environment. 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: - Environments get: description: Retrieve detailed information about given Cloud Credentials that this Environment is using. responses: 200: description: The JSON representation of a CloudCredentials object. schema: $ref: '#/definitions/CloudCredentialsDetailsResponse' 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: - Environments post: description: Associate or replace Cloud Credentials with this Environment for the given Cloud. parameters: - description: The JSON representation of a CloudCredentialsForeignKey object. in: body name: cloudCredentialsForeignKeyObject required: true schema: $ref: '#/definitions/CloudCredentialsForeignKey' responses: 200: description: The JSON representation of a CloudCredentials object. schema: $ref: '#/definitions/CloudCredentialsDetailsResponse' 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: - Environments /{accountId}/environments/{envId}/teams/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer - description: The ID of the Environment being accessed. in: path name: envId required: true type: integer get: description: List the Teams that have access to this Environment. responses: 200: description: A list of EnvironmentTeam objects. schema: $ref: '#/definitions/EnvironmentTeamListResponse' 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: - Environments post: description: Grants a Team access to this Environment. parameters: - description: The JSON representation of a EnvironmentTeam object. in: body name: environmentTeamObject required: true schema: $ref: '#/definitions/EnvironmentTeam' responses: 201: description: The JSON representation of a EnvironmentTeam object. schema: $ref: '#/definitions/EnvironmentTeamDetailsResponse' 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: - Environments /{accountId}/environments/{envId}/teams/{teamId}/: parameters: - description: The ID of the Account scoping this request. in: path name: accountId required: true type: integer - description: The ID of the Environment being accessed. in: path name: envId required: true type: integer - description: The ID of a Team object. in: path name: teamId required: true type: integer x-references: $ref: '#/definitions/Team' delete: description: Withhold a Team's access to this Environment. 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: - Environments patch: description: Update the attributes of an Team access on this Environment. parameters: - description: The JSON representation of a EnvironmentTeam object. in: body name: environmentTeamObject required: true schema: $ref: '#/definitions/EnvironmentTeam' responses: 200: description: The JSON representation of a EnvironmentTeam object. schema: $ref: '#/definitions/EnvironmentTeamDetailsResponse' 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: - Environments definitions: Environment: properties: added: format: date-time readOnly: true type: string costCenter: $ref: '#/definitions/CostCenterForeignKey' id: readOnly: true type: integer name: type: string status: enum: - active - inactive type: string type: default: cmp enum: - cmp - iacp type: string required: - name x-createOnly: - type x-filterable: - id - name - added - status - type - costCenter x-usedIn: - /account/{accountId}/environments/ - /account/{accountId}/environments/{envId}/ CloudstackCloudCredentials: properties: apiKey: description: The API key. type: string apiUrl: description: 'The URL like: http(s)://:/client/api.' type: string cloudCredentialsType: description: The Cloud Platform these credentials allow access to. enum: - AwsCloudCredentials - GceCloudCredentials - AzureCloudCredentials - CloudstackCloudCredentials - OpenstackCloudCredentials - RackspaceCloudCredentials - VmwareCloudCredentials type: string description: type: string id: description: Unique identifier for this Cloud Credentials object. maxLength: 12 minLength: 12 pattern: '[A-Fa-f0-9]+' readOnly: true type: string name: description: Unique name of these Cloud Credentials. type: string provider: description: Cloud provider that should be specified for CloudStack based clouds. enum: - cloudstack - idcf type: string scope: description: The scope in which these Cloud Credentials were added. enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string secretKey: description: The secret key. type: string status: description: The status of these Cloud Credentials. enum: - disabled - enabled - suspended readOnly: true type: string required: - name - cloudCredentialsType - provider - apiUrl - apiKey - secretKey x-abstractType: $ref: '#/definitions/CloudCredentials' x-createOnly: - cloudCredentialsType - provider - provider x-discriminator: cloudCredentialsType x-filterable: - id - name - cloudCredentialsType - status - scope - provider ApiPagination: properties: first: readOnly: true type: string last: readOnly: true type: string next: readOnly: true type: string prev: readOnly: true type: string AclRoleForeignKey: properties: id: description: Unique identifier for this ACL Role object. type: string required: - id x-derived: $ref: '#/definitions/AclRole' x-references: $ref: '#/definitions/AclRole' ComposedTeamIdentity: properties: id: description: Unique identifier for a Team. type: integer name: description: Team name. readOnly: true type: string required: - id VmwareCloudCredentials: properties: cloudCredentialsType: description: The Cloud Platform these credentials allow access to. enum: - AwsCloudCredentials - GceCloudCredentials - AzureCloudCredentials - CloudstackCloudCredentials - OpenstackCloudCredentials - RackspaceCloudCredentials - VmwareCloudCredentials type: string description: type: string id: description: Unique identifier for this Cloud Credentials object. maxLength: 12 minLength: 12 pattern: '[A-Fa-f0-9]+' readOnly: true type: string name: description: Unique name of these Cloud Credentials. type: string password: description: The password for the user. format: password type: string provider: description: Cloud provider for Openstack or Cloudstack based clouds. type: string scope: description: The scope in which these Cloud Credentials were added. enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string sslVerification: description: Specifies whether it should verify SSL Certificate. type: boolean status: description: The status of these Cloud Credentials. enum: - disabled - enabled - suspended readOnly: true type: string url: description: vSphere Web Services SDK Server URL. type: string userName: description: The ID of the user. type: string required: - name - cloudCredentialsType - url - userName - password x-abstractType: $ref: '#/definitions/CloudCredentials' x-createOnly: - cloudCredentialsType - provider x-discriminator: cloudCredentialsType x-filterable: - id - name - cloudCredentialsType - status - scope - provider 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}/ EnvironmentTeamListResponse: properties: data: items: $ref: '#/definitions/EnvironmentTeam' 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/EnvironmentTeam' x-usedIn: - /account/{accountId}/environments/{envId}/teams/ Team: properties: defaultAclRole: $ref: '#/definitions/AclRoleForeignKey' description: Default ACL Role for the Team. This ACL Role is applied by default to all the members of the Team, but it can be overridden for specific users. description: description: Description of the Team. type: string id: description: Identifier of the Team. readOnly: true type: integer name: description: Name of the Team. type: string required: - defaultAclRole - name x-filterable: - id - name - defaultAclRole x-usedIn: - /account/{accountId}/environments/{envId}/teams/{teamId}/ - /account/{accountId}/teams/ - /account/{accountId}/teams/{teamId}/ ApiMetaContainer: properties: sample: description: Actual properties TBD. type: string CloudCredentials: discriminator: cloudCredentialsType properties: cloudCredentialsType: description: The Cloud Platform these credentials allow access to. enum: - AwsCloudCredentials - GceCloudCredentials - AzureCloudCredentials - CloudstackCloudCredentials - OpenstackCloudCredentials - RackspaceCloudCredentials - VmwareCloudCredentials type: string description: type: string id: description: Unique identifier for this Cloud Credentials object. maxLength: 12 minLength: 12 pattern: '[A-Fa-f0-9]+' readOnly: true type: string name: description: Unique name of these Cloud Credentials. type: string provider: description: Cloud provider for Openstack or Cloudstack based clouds. type: string scope: description: The scope in which these Cloud Credentials were added. enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string status: description: The status of these Cloud Credentials. enum: - disabled - enabled - suspended readOnly: true type: string required: - name - cloudCredentialsType x-concreteTypes: - $ref: '#/definitions/AwsCloudCredentials' - $ref: '#/definitions/GceCloudCredentials' - $ref: '#/definitions/OpenstackCloudCredentials' - $ref: '#/definitions/CloudstackCloudCredentials' - $ref: '#/definitions/RackspaceCloudCredentials' - $ref: '#/definitions/AzureCloudCredentials' - $ref: '#/definitions/VmwareCloudCredentials' x-createOnly: - cloudCredentialsType - provider x-filterable: - id - name - cloudCredentialsType - status - scope - provider x-usedIn: - /account/{accountId}/cloud-credentials/ - /account/{accountId}/cloud-credentials/{cloudCredentialsId}/ EnvironmentListResponse: properties: data: items: $ref: '#/definitions/Environment' 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/Environment' x-usedIn: - /account/{accountId}/environments/ EnvironmentTeamDetailsResponse: properties: data: $ref: '#/definitions/EnvironmentTeam' 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/EnvironmentTeam' x-usedIn: - /account/{accountId}/environments/{envId}/teams/ - /account/{accountId}/environments/{envId}/teams/{teamId}/ OpenstackCloudCredentials: properties: cloudCredentialsType: description: The Cloud Platform these credentials allow access to. enum: - AwsCloudCredentials - GceCloudCredentials - AzureCloudCredentials - CloudstackCloudCredentials - OpenstackCloudCredentials - RackspaceCloudCredentials - VmwareCloudCredentials type: string description: type: string domainName: description: Domain name. It must be provided for the Identity API v3. type: string id: description: Unique identifier for this Cloud Credentials object. maxLength: 12 minLength: 12 pattern: '[A-Fa-f0-9]+' readOnly: true type: string keystoneUrl: description: Keystone URL. type: string name: description: Unique name of these Cloud Credentials. type: string password: description: The password for the user. format: password type: string provider: description: Cloud provider that should be specified for OpenStack based clouds. enum: - openstack - ocs - hpcloud - mirantis - vio - cisco type: string scope: description: The scope in which these Cloud Credentials were added. enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string sslVerification: description: Specifies whether it should verify SSL Certificate. type: boolean status: description: The status of these Cloud Credentials. enum: - disabled - enabled - suspended readOnly: true type: string tenantName: description: The tenant name. type: string userName: description: The user name. type: string required: - name - cloudCredentialsType - provider - keystoneUrl - userName - password - tenantName x-abstractType: $ref: '#/definitions/CloudCredentials' x-createOnly: - cloudCredentialsType - provider - provider x-discriminator: cloudCredentialsType x-filterable: - id - name - cloudCredentialsType - status - scope - provider CloudCredentialsForeignKey: properties: id: description: Unique identifier of a Cloud Credentials object. type: string required: - id x-usedIn: - /account/{accountId}/environments/{envId}/clouds/{cloud}/ GceCloudCredentials: properties: accountName: description: The service account name. type: string clientId: description: GCE client ID. type: string cloudCredentialsType: description: The Cloud Platform these credentials allow access to. enum: - AwsCloudCredentials - GceCloudCredentials - AzureCloudCredentials - CloudstackCloudCredentials - OpenstackCloudCredentials - RackspaceCloudCredentials - VmwareCloudCredentials type: string description: type: string id: description: Unique identifier for this Cloud Credentials object. maxLength: 12 minLength: 12 pattern: '[A-Fa-f0-9]+' readOnly: true type: string name: description: Unique name of these Cloud Credentials. type: string privateKey: description: Private key with boundary. format: byte type: string projectId: description: GCE project ID. type: string provider: description: Cloud provider for Openstack or Cloudstack based clouds. type: string scope: description: The scope in which these Cloud Credentials were added. enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string status: description: The status of these Cloud Credentials. enum: - disabled - enabled - suspended readOnly: true type: string required: - name - cloudCredentialsType - projectId - clientId - accountName - privateKey x-abstractType: $ref: '#/definitions/CloudCredentials' x-createOnly: - cloudCredentialsType - provider x-discriminator: cloudCredentialsType x-filterable: - id - name - cloudCredentialsType - status - scope - provider AwsCloudCredentials: properties: accessKey: description: Access key ID. type: string accountId: description: AWS Account ID. readOnly: true type: string accountType: description: AWS Account type. enum: - regular - govcloud - china type: string billing: $ref: '#/definitions/AwsDetailedBilling' cloudCredentialsType: description: The Cloud Platform these credentials allow access to. enum: - AwsCloudCredentials - GceCloudCredentials - AzureCloudCredentials - CloudstackCloudCredentials - OpenstackCloudCredentials - RackspaceCloudCredentials - VmwareCloudCredentials type: string description: type: string id: description: Unique identifier for this Cloud Credentials object. maxLength: 12 minLength: 12 pattern: '[A-Fa-f0-9]+' readOnly: true type: string name: description: Unique name of these Cloud Credentials. type: string provider: description: Cloud provider for Openstack or Cloudstack based clouds. type: string scope: description: The scope in which these Cloud Credentials were added. enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string secretKey: description: The secret key. type: string status: description: The status of these Cloud Credentials. enum: - disabled - enabled - suspended readOnly: true type: string required: - name - cloudCredentialsType - accountType - accessKey - secretKey x-abstractType: $ref: '#/definitions/CloudCredentials' x-createOnly: - cloudCredentialsType - provider x-discriminator: cloudCredentialsType x-filterable: - id - name - cloudCredentialsType - status - scope - provider - accountType CloudListResponse: properties: data: items: $ref: '#/definitions/Cloud' 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/Cloud' x-usedIn: - /account/{accountId}/environments/{envId}/clouds/ Cloud: properties: cloud: description: The Cloud Platform this resource resides in. enum: - ec2 - gce type: string credentials: $ref: '#/definitions/CloudCredentialsForeignKey' AclRole: properties: baseRole: description: Base ACL Role to override. enum: - no-access - full-access - read-only type: string id: description: Unique identifier for this ACL Role object. maxLength: 20 minLength: 20 pattern: '[A-Fa-f0-9]+' readOnly: true type: string name: description: Name of this ACL Role. type: string required: - name x-createOnly: - baseRole x-filterable: - id - name - baseRole CloudCredentialsDetailsResponse: properties: data: $ref: '#/definitions/CloudCredentials' 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/CloudCredentials' x-usedIn: - /account/{accountId}/environments/{envId}/clouds/{cloud}/ - /account/{accountId}/cloud-credentials/ - /account/{accountId}/cloud-credentials/{cloudCredentialsId}/ EnvironmentDetailsResponse: properties: data: $ref: '#/definitions/Environment' 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/Environment' x-usedIn: - /account/{accountId}/environments/ - /account/{accountId}/environments/{envId}/ AzureCloudCredentials: properties: cloudCredentialsType: description: The Cloud Platform these credentials allow access to. enum: - AwsCloudCredentials - GceCloudCredentials - AzureCloudCredentials - CloudstackCloudCredentials - OpenstackCloudCredentials - RackspaceCloudCredentials - VmwareCloudCredentials type: string description: type: string id: description: Unique identifier for this Cloud Credentials object. maxLength: 12 minLength: 12 pattern: '[A-Fa-f0-9]+' readOnly: true type: string name: description: Unique name of these Cloud Credentials. type: string provider: description: Cloud provider for Openstack or Cloudstack based clouds. type: string scope: description: The scope in which these Cloud Credentials were added. enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string status: description: The status of these Cloud Credentials. enum: - disabled - enabled - suspended readOnly: true type: string subscription: description: The Azure Subscription ID. type: string tenantId: description: The Azure Active Directory identifier. type: string required: - name - cloudCredentialsType - tenantId - subscription x-abstractType: $ref: '#/definitions/CloudCredentials' x-createOnly: - cloudCredentialsType - provider x-discriminator: cloudCredentialsType x-filterable: - id - name - cloudCredentialsType - status - scope - provider AwsDetailedBilling: properties: bucket: description: Billing bucket name. type: string cloudCredentials: $ref: '#/definitions/CloudCredentialsForeignKey' description: Payer AWS Cloud Credentials. cloudLocation: description: Billing bucket region. type: string enabled: default: false description: Whether detailed billing is enabled. type: boolean EnvironmentTeam: properties: defaultAclRole: $ref: '#/definitions/AclRoleForeignKey' description: Default ACL Role to override the Team's default ACL Role for this Environment. If it is omitted Team's default ACL Role will be used. Note that this default ACL Role is only applied for members of the Team that don't have an explicitly defined ACL Role. team: $ref: '#/definitions/ComposedTeamIdentity' description: Identifier and name of the Team. required: - team x-createOnly: - team x-filterable: - team - defaultAclRole x-usedIn: - /account/{accountId}/environments/{envId}/teams/ - /account/{accountId}/environments/{envId}/teams/{teamId}/ ApiMessage: properties: code: description: A machine-readable representation of the message. type: string message: description: A human-readable representation of the message. type: string RackspaceCloudCredentials: properties: apiKey: description: The API access key. type: string cloudCredentialsType: description: The Cloud Platform these credentials allow access to. enum: - AwsCloudCredentials - GceCloudCredentials - AzureCloudCredentials - CloudstackCloudCredentials - OpenstackCloudCredentials - RackspaceCloudCredentials - VmwareCloudCredentials type: string description: type: string id: description: Unique identifier for this Cloud Credentials object. maxLength: 12 minLength: 12 pattern: '[A-Fa-f0-9]+' readOnly: true type: string isUk: description: Indicates if these credentials are for Rackspace UK (true) or Rackspace US (false). type: boolean name: description: Unique name of these Cloud Credentials. type: string provider: description: Cloud provider for Openstack or Cloudstack based clouds. type: string scope: description: The scope in which these Cloud Credentials were added. enum: - scalr - account - environment - farm - farmrole - role - server readOnly: true type: string status: description: The status of these Cloud Credentials. enum: - disabled - enabled - suspended readOnly: true type: string userName: description: The user name. type: string required: - name - cloudCredentialsType - userName - apiKey x-abstractType: $ref: '#/definitions/CloudCredentials' x-createOnly: - cloudCredentialsType - provider - isUk x-discriminator: cloudCredentialsType x-filterable: - id - name - cloudCredentialsType - status - scope - provider 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