Skip to content

Instantly share code, notes, and snippets.

@igable

igable/swagger.json

Created October 29, 2015 22:28
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save igable/efee8309fb7a4479eb98 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save igable/efee8309fb7a4479eb98 to your computer and use it in GitHub Desktop.
Download ZIP
swagger.json
Raw
swagger.json
{
"swagger" : "2.0",
"info" : {
"description" : "Prototype Dispatcher API documention",
"version" : "2.0.0",
"title" : "DCM Dispatcher API V2"
},
"host" : "localhost:8081",
"basePath" : "/rest/v2",
"tags" : [ {
"name" : "server"
}, {
"name" : "roles"
}, {
"name" : "user"
}, {
"name" : "groups"
}, {
"name" : "catalog"
} ],
"schemes" : [ "http" ],
"paths" : {
"/admin/groups" : {
"get" : {
"tags" : [ "groups" ],
"summary" : "List available groups",
"description" : "",
"operationId" : "getGroups",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/GroupDTO"
}
}
},
"403" : {
"description" : "Not authorized to retrieve a list of users"
}
}
},
"post" : {
"tags" : [ "groups" ],
"summary" : "Create a a group",
"description" : "",
"operationId" : "createGroup",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/AddUpdateUserGroupCmd"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/GroupDTO"
}
},
"403" : {
"description" : "Not authorized to create group"
}
}
},
"delete" : {
"tags" : [ "groups" ],
"summary" : "Delete a list of groups",
"description" : "V2 Note: changed from POST /delete",
"operationId" : "deleteListOfGroups",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/GroupDescription"
}
}
} ],
"responses" : {
"403" : {
"description" : "Delete a collection of groups"
}
}
}
},
"/admin/groups/{id}" : {
"get" : {
"tags" : [ "groups" ],
"summary" : "Get a specific group",
"description" : "",
"operationId" : "getGroup",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "the group id",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "Group not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/GroupDTO"
}
},
"403" : {
"description" : "Not authorized to retrieve this group"
}
}
},
"put" : {
"tags" : [ "groups" ],
"summary" : "Update a group",
"description" : "",
"operationId" : "updateGroup",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "the group id",
"required" : true,
"type" : "integer",
"format" : "int64"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/AddUpdateUserGroupCmd"
}
} ],
"responses" : {
"404" : {
"description" : "Group not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/GroupDTO"
}
},
"403" : {
"description" : "Not authorized to update group"
}
}
},
"delete" : {
"tags" : [ "groups" ],
"summary" : "Delete a group",
"description" : "",
"operationId" : "deleteGroup",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "the group id",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "Group not found"
},
"403" : {
"description" : "Not authorized to delete group"
}
}
}
},
"/admin/roles" : {
"get" : {
"tags" : [ "roles" ],
"summary" : "List available roles",
"description" : "",
"operationId" : "getRoles",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RoleInfo"
}
}
},
"403" : {
"description" : "Not authorized to get roles"
}
}
},
"post" : {
"tags" : [ "roles" ],
"summary" : "Create a a role",
"description" : "",
"operationId" : "createRole",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/AddUpdateUserGroupCmd"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/RoleInfo"
}
},
"403" : {
"description" : "Not authorized to create role"
}
}
}
},
"/admin/roles/delete" : {
"post" : {
"tags" : [ "roles" ],
"summary" : "Delete a collection of roles",
"description" : "V2 Note: Consider changing",
"operationId" : "deleteListOfGroups",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ ],
"responses" : {
"404" : {
"description" : "One or more roles not found"
},
"403" : {
"description" : "Not authorized to delete roles"
}
}
}
},
"/admin/roles/{id}" : {
"get" : {
"tags" : [ "roles" ],
"summary" : "Get a specific role",
"description" : "",
"operationId" : "getRole",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "the role id",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "Role not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/RoleInfo"
}
},
"403" : {
"description" : "Not authorized to retrieve this role"
}
}
},
"put" : {
"tags" : [ "roles" ],
"summary" : "Update a role",
"description" : "",
"operationId" : "updateRole",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "the role id",
"required" : true,
"type" : "integer",
"format" : "int64"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/AddUpdateUserGroupCmd"
}
} ],
"responses" : {
"404" : {
"description" : "Role not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/RoleInfo"
}
},
"403" : {
"description" : "Not authorized to update role"
}
}
},
"delete" : {
"tags" : [ "roles" ],
"summary" : "Delete a role",
"description" : "",
"operationId" : "deleteRole",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "the role id",
"required" : true,
"type" : "integer",
"format" : "int64"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/AddUpdateUserGroupCmd"
}
} ],
"responses" : {
"404" : {
"description" : "Role not found"
},
"403" : {
"description" : "Not authorized to delete role"
}
}
}
},
"/admin/user" : {
"get" : {
"tags" : [ "user" ],
"summary" : "Retrieves list of users for a customer",
"description" : "",
"operationId" : "getUsers",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/UserSummary"
}
}
},
"403" : {
"description" : "Not authorized to retrieve this list of users"
}
}
},
"post" : {
"tags" : [ "user" ],
"summary" : "Creates a new User for a customer",
"description" : "Requires user admin privilege",
"operationId" : "createUser",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/CatalogCmd"
}
} ],
"responses" : {
"409" : {
"description" : "User already exists"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UserSummary"
}
},
"403" : {
"description" : "Not authorized to create user"
}
}
}
},
"/admin/user/{userId}" : {
"get" : {
"tags" : [ "user" ],
"summary" : "Retrieves a User",
"description" : "",
"operationId" : "getUser",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "userId",
"in" : "path",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "No user found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UserSummary"
}
},
"403" : {
"description" : "Not authorized to retrieve this particular user"
}
}
},
"put" : {
"tags" : [ "user" ],
"summary" : "Updates an existing user.",
"description" : "",
"operationId" : "editUser",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "userId",
"in" : "path",
"required" : true,
"type" : "integer",
"format" : "int64"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/AddUpdateUserCmd"
}
} ],
"responses" : {
"404" : {
"description" : "User does not exist"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UserSummary"
}
},
"403" : {
"description" : "Not authorized to update user"
}
}
},
"delete" : {
"tags" : [ "user" ],
"summary" : "Deactivates a User",
"description" : "",
"operationId" : "deleteCatalog",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "userId",
"in" : "path",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "User does not exist"
},
"403" : {
"description" : "Not authorized to remove user"
}
}
}
},
"/automation/catalog" : {
"get" : {
"tags" : [ "catalog" ],
"summary" : "Retrieves a customer catalog",
"description" : "",
"operationId" : "getCustomerCatalog",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "customerId",
"in" : "query",
"description" : "Customer Id",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "No customer catalog found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CatalogDescription"
}
},
"400" : {
"description" : "Invalid customerId provided"
},
"403" : {
"description" : "Not authorized to retrieve this particular catalog"
}
}
},
"post" : {
"tags" : [ "catalog" ],
"summary" : "Creates a service catalog",
"description" : "Requires catalog admin privilege",
"operationId" : "createCatalog",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/CatalogCmd"
}
} ],
"responses" : {
"409" : {
"description" : "Catalog already exists"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CatalogDescription"
}
},
"403" : {
"description" : "Not authorized to create company catalog"
}
}
}
},
"/automation/catalog/public" : {
"get" : {
"tags" : [ "catalog" ],
"summary" : "Retrieves the public catalog",
"description" : "",
"operationId" : "getPublicCatalog",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ ],
"responses" : {
"404" : {
"description" : "No public catalog found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CatalogDescription"
}
},
"403" : {
"description" : "Not authorized to retrieve this particular catalog"
}
}
}
},
"/automation/catalog/{catalogId}" : {
"get" : {
"tags" : [ "catalog" ],
"summary" : "Retrieves a catalog",
"description" : "",
"operationId" : "getCatalog",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "catalogId",
"in" : "path",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "No catalog found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CatalogDescription"
}
},
"403" : {
"description" : "Not authorized to retrieve this particular catalog"
}
}
},
"put" : {
"tags" : [ "catalog" ],
"summary" : "Updates an existing catalog.",
"description" : "Requires either the \"catalog admin\" access or \"public catalog admin\" access depending on catalog type.",
"operationId" : "editCatalog",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "catalogId",
"in" : "path",
"required" : true,
"type" : "integer",
"format" : "int64"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/CatalogCmd"
}
} ],
"responses" : {
"404" : {
"description" : "Catalog does not exist"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CatalogDescription"
}
},
"403" : {
"description" : "Not authorized to update catalog"
}
}
},
"delete" : {
"tags" : [ "catalog" ],
"summary" : "Removes a service catalog.",
"description" : "Requires either the \"catalog admin\" access or \"public catalog admin\" access depending on catalog type.",
"operationId" : "deleteCatalog",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "catalogId",
"in" : "path",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/infrastructure/server" : {
"get" : {
"tags" : [ "server" ],
"summary" : "Retrieves a list of Server",
"description" : "",
"operationId" : "getServers",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "activeOnly",
"in" : "query",
"description" : "return active servers only",
"required" : true,
"type" : "boolean"
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ServerDescription"
}
}
},
"403" : {
"description" : "Not authorized to retrieve the list of servers"
}
}
},
"post" : {
"tags" : [ "server" ],
"summary" : "Create a server",
"description" : "",
"operationId" : "createServer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ServerDescription"
}
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ServerDescription"
}
},
"403" : {
"description" : "Not authorized to retrieve the list of servers"
}
}
}
},
"/infrastructure/server/pause" : {
"put" : {
"tags" : [ "server" ],
"summary" : "Request a collection of servers be paused",
"description" : "",
"operationId" : "pauseServerList",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
}
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JobDescription"
}
},
"403" : {
"description" : "Not authorized to pause servers"
}
}
}
},
"/infrastructure/server/restart" : {
"put" : {
"tags" : [ "server" ],
"summary" : "Request a collection of servers be restarted",
"description" : "",
"operationId" : "restartServerList",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
}
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JobDescription"
}
},
"403" : {
"description" : "Not authorized to restart servers"
}
}
}
},
"/infrastructure/server/start" : {
"put" : {
"tags" : [ "server" ],
"summary" : "Request a collection of servers be started",
"description" : "",
"operationId" : "startServerList",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
}
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JobDescription"
}
},
"403" : {
"description" : "Not authorized to terminate servers"
}
}
}
},
"/infrastructure/server/terminate" : {
"put" : {
"tags" : [ "server" ],
"summary" : "Request a collection of servers be terminated",
"description" : "",
"operationId" : "deleteServerList",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
}
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JobDescription"
}
},
"403" : {
"description" : "Not authorized to update the servers"
}
}
}
},
"/infrastructure/server/{serverId}" : {
"get" : {
"tags" : [ "server" ],
"summary" : "Retrieves a server",
"description" : "",
"operationId" : "getServer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "serverId",
"in" : "path",
"description" : "the server id",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "Server not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ServerDescription"
}
},
"403" : {
"description" : "Not authorized to retrieve this server"
}
}
},
"put" : {
"tags" : [ "server" ],
"summary" : "Update a server",
"description" : "",
"operationId" : "updateServer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "serverId",
"in" : "path",
"description" : "the server id",
"required" : true,
"type" : "integer",
"format" : "int64"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ServerDescription"
}
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ServerDescription"
}
},
"403" : {
"description" : "Not authorized to update the servers"
}
}
}
},
"/infrastructure/server/{serverId}/pause" : {
"put" : {
"tags" : [ "server" ],
"summary" : "Request a server be paused",
"description" : "",
"operationId" : "pauseServer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "serverId",
"in" : "path",
"description" : "the server id",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JobDescription"
}
},
"403" : {
"description" : "Request a server be paused"
}
}
}
},
"/infrastructure/server/{serverId}/restart" : {
"put" : {
"tags" : [ "server" ],
"summary" : "Request a server be restarted",
"description" : "",
"operationId" : "restartServer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "serverId",
"in" : "path",
"description" : "the server id",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JobDescription"
}
},
"403" : {
"description" : "Request a server be restarted"
}
}
}
},
"/infrastructure/server/{serverId}/start" : {
"put" : {
"tags" : [ "server" ],
"summary" : "Request a server be started",
"description" : "",
"operationId" : "startServer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "serverId",
"in" : "path",
"description" : "the server id",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JobDescription"
}
},
"403" : {
"description" : "Request a server be started"
}
}
}
},
"/infrastructure/server/{serverId}/terminate" : {
"put" : {
"tags" : [ "server" ],
"summary" : "Request a server be terminated",
"description" : "",
"operationId" : "deleteServer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "serverId",
"in" : "path",
"description" : "the server id",
"required" : true,
"type" : "integer",
"format" : "int64"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ServerDescription"
}
} ],
"responses" : {
"404" : {
"description" : "Not found"
},
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JobDescription"
}
},
"403" : {
"description" : "Not authorized to update the servers"
}
}
}
}
},
"definitions" : {
"DeploymentRequirementsDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"compliance" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "NONE", "CSA", "PCI" ]
}
},
"deploymentTargetId" : {
"type" : "integer",
"format" : "int64"
},
"deploymentTemplateId" : {
"type" : "integer",
"format" : "int64"
},
"details" : {
"$ref" : "#/definitions/DeploymentRequirementsDetails"
},
"dnsNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"encryptionAtRest" : {
"type" : "string",
"enum" : [ "NONE", "PUBLIC", "ALL" ]
},
"encryptionInTransit" : {
"type" : "string",
"enum" : [ "NONE", "PUBLIC", "ALL" ]
},
"disallowPublicCloud" : {
"type" : "boolean",
"default" : false
},
"extrajurisdictionalDr" : {
"type" : "boolean",
"default" : false
},
"jurisdictions" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "AU", "BR", "CA", "CH", "CN", "DE", "HK", "IN", "JP", "EU", "US", "SG", "IL", "MX", "KR", "RU", "TW", "ZA", "OTHER" ]
}
},
"maximumLatencyInMillis" : {
"type" : "integer",
"format" : "int32"
},
"maximumMonthlyBudget" : {
"type" : "number",
"format" : "float"
},
"minimumBandwidthInMb" : {
"type" : "integer",
"format" : "int32"
},
"targetAvailability" : {
"type" : "number",
"format" : "float"
},
"warningMessages" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "AVAILABILITY_NOT_WITHIN_BUDGET", "NO_REGIONS", "INSUFFICIENT_REGIONS_FOR_AVAILABILITY", "NO_PRIVATE_CLOUD_REGIONS", "NO_COMMON_REGIONS", "TIERS_MISSING_REGIONS" ]
}
},
"dnsNamesString" : {
"type" : "string"
}
}
},
"DeploymentStatsDescription" : {
"type" : "object",
"properties" : {
"actualAvailability" : {
"type" : "number",
"format" : "float"
},
"currentAlarmId" : {
"type" : "integer",
"format" : "int64"
},
"estimatedAvailability" : {
"type" : "number",
"format" : "float"
},
"estimatedMonthlyCost" : {
"type" : "number",
"format" : "float"
},
"lastNodeFailureId" : {
"type" : "integer",
"format" : "int64"
},
"lastSystemFailureId" : {
"type" : "integer",
"format" : "int64"
},
"monthlyCostToDate" : {
"type" : "number",
"format" : "float"
},
"nodeFailureCount" : {
"type" : "integer",
"format" : "int32"
},
"runningTime" : {
"type" : "integer",
"format" : "int64"
},
"systemFailureCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"ServerProductDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"architecture" : {
"type" : "string",
"enum" : [ "I32", "I64", "POWER", "SPARC" ]
},
"billingCurrency" : {
"type" : "string"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"cpuCount" : {
"type" : "number",
"format" : "float"
},
"description" : {
"type" : "string"
},
"diskSizeInGb" : {
"type" : "integer",
"format" : "int32"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"platform" : {
"type" : "string",
"enum" : [ "UNIX", "UBUNTU", "DEBIAN", "SOLARIS", "FEDORA_CORE", "RHEL", "FREE_BSD", "OPEN_BSD", "CENT_OS", "COREOS", "WINDOWS", "SUSE", "SMARTOS", "UNKNOWN" ]
},
"prepaymentTermInMonths" : {
"type" : "integer",
"format" : "int32"
},
"providerProductId" : {
"type" : "string"
},
"providerRegionId" : {
"type" : "string"
},
"ramInMb" : {
"type" : "integer",
"format" : "int32"
},
"serverProductId" : {
"type" : "integer",
"format" : "int64"
},
"software" : {
"type" : "string"
},
"standardPricingHourly" : {
"type" : "number",
"format" : "float"
},
"standardPricingPrepaid" : {
"type" : "number",
"format" : "float"
},
"standardPricingCurrency" : {
"type" : "string"
}
}
},
"SubnetDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"customerBillingId" : {
"type" : "integer",
"format" : "int64"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"hasShadow" : {
"type" : "boolean",
"default" : false
},
"shadowState" : {
"type" : "string"
},
"shadowDescription" : {
"type" : "string"
},
"dataCenterId" : {
"type" : "integer",
"format" : "int64"
},
"dataCenterName" : {
"type" : "string"
},
"details" : {
"$ref" : "#/definitions/SubnetDetails"
},
"networkAddress" : {
"type" : "string"
},
"networkId" : {
"type" : "integer",
"format" : "int64"
},
"providerSubnetId" : {
"type" : "string"
},
"resourceLocator" : {
"type" : "string"
},
"subnetId" : {
"type" : "integer",
"format" : "int64"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"billingId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"RegionSubscriptionDescription" : {
"type" : "object",
"properties" : {
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"customImagesSupported" : {
"type" : "boolean",
"default" : false
},
"firewallCreationAllowed" : {
"type" : "boolean",
"default" : false
},
"hypervisorAnalyticsSupported" : {
"type" : "boolean",
"default" : false
},
"ipAddressForwarding" : {
"type" : "boolean",
"default" : false
},
"loadBalancerAddressAssigned" : {
"type" : "boolean",
"default" : false
},
"loadBalancerDataCenterLimited" : {
"type" : "boolean",
"default" : false
},
"loadBalancerMaxListeners" : {
"type" : "integer",
"format" : "int32"
},
"privateImageSharingSupported" : {
"type" : "boolean",
"default" : false
},
"privateIpAddressAssignable" : {
"type" : "boolean",
"default" : false
},
"privateIpAddressRequestable" : {
"type" : "boolean",
"default" : false
},
"privateSnapshotSharingSupported" : {
"type" : "boolean",
"default" : false
},
"publicImageSharingSupported" : {
"type" : "boolean",
"default" : false
},
"publicIpAddressAssignable" : {
"type" : "boolean",
"default" : false
},
"publicIpAddressRequestable" : {
"type" : "boolean",
"default" : false
},
"publicLibraryAvailable" : {
"type" : "boolean",
"default" : false
},
"publicSnapshotSharingSupported" : {
"type" : "boolean",
"default" : false
},
"rdbmsFirewalled" : {
"type" : "boolean",
"default" : false
},
"rdbmsHighAvailability" : {
"type" : "boolean",
"default" : false
},
"rdbmsLowAvailability" : {
"type" : "boolean",
"default" : false
},
"rdbmsMaintenance" : {
"type" : "boolean",
"default" : false
},
"rdbmsSnapshots" : {
"type" : "boolean",
"default" : false
},
"shellKeyBootstrapped" : {
"type" : "boolean",
"default" : false
},
"subnetCreationAllowed" : {
"type" : "boolean",
"default" : false
},
"subscribedArchiveStore" : {
"type" : "boolean",
"default" : false
},
"subscribedAutoScaling" : {
"type" : "boolean",
"default" : false
},
"subscribedBlobStore" : {
"type" : "boolean",
"default" : false
},
"subscribedCdn" : {
"type" : "boolean",
"default" : false
},
"subscribedDns" : {
"type" : "boolean",
"default" : false
},
"subscribedEmail" : {
"type" : "boolean",
"default" : false
},
"subscribedFirewall" : {
"type" : "boolean",
"default" : false
},
"subscribedImage" : {
"type" : "boolean",
"default" : false
},
"subscribedIpAddress" : {
"type" : "boolean",
"default" : false
},
"subscribedKeyValueDatabase" : {
"type" : "boolean",
"default" : false
},
"subscribedLoadBalancer" : {
"type" : "boolean",
"default" : false
},
"subscribedMessageQueue" : {
"type" : "boolean",
"default" : false
},
"subscribedPushNotifications" : {
"type" : "boolean",
"default" : false
},
"subscribedRelationalDatabase" : {
"type" : "boolean",
"default" : false
},
"subscribedServer" : {
"type" : "boolean",
"default" : false
},
"subscribedSnapshot" : {
"type" : "boolean",
"default" : false
},
"subscribedVlan" : {
"type" : "boolean",
"default" : false
},
"subscribedVolume" : {
"type" : "boolean",
"default" : false
},
"subscribedVpn" : {
"type" : "boolean",
"default" : false
},
"vlanCreationAllowed" : {
"type" : "boolean",
"default" : false
},
"vlanDcConstrained" : {
"type" : "boolean",
"default" : false
},
"subnetDcConstrained" : {
"type" : "boolean",
"default" : false
},
"userDataSupported" : {
"type" : "boolean",
"default" : false
},
"vmProductDcConstrained" : {
"type" : "boolean",
"default" : false
},
"serverClone" : {
"type" : "boolean",
"default" : false
},
"serverPause" : {
"type" : "boolean",
"default" : false
},
"serverReboot" : {
"type" : "boolean",
"default" : false
},
"serverResume" : {
"type" : "boolean",
"default" : false
},
"serverStart" : {
"type" : "boolean",
"default" : false
},
"serverStop" : {
"type" : "boolean",
"default" : false
},
"serverSuspend" : {
"type" : "boolean",
"default" : false
},
"serverUnpause" : {
"type" : "boolean",
"default" : false
},
"serverTerminate" : {
"type" : "boolean",
"default" : false
},
"lbCreateHcRequirement" : {
"type" : "string",
"enum" : [ "NONE", "OPTIONAL", "REQUIRED" ]
},
"deviceIdOnAttach" : {
"type" : "string",
"enum" : [ "NONE", "OPTIONAL", "REQUIRED" ]
}
}
},
"EventDescription" : {
"type" : "object",
"properties" : {
"agentEmail" : {
"type" : "string"
},
"agentId" : {
"type" : "integer",
"format" : "int64"
},
"agentName" : {
"type" : "string"
},
"detailsAsJson" : {
"type" : "string"
},
"eventId" : {
"type" : "integer",
"format" : "int64"
},
"eventSubtype" : {
"type" : "string"
},
"eventTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"eventType" : {
"type" : "string"
},
"remoteIp" : {
"type" : "string"
},
"resourceId" : {
"type" : "integer",
"format" : "int64"
},
"resourceType" : {
"type" : "string"
}
}
},
"RegionDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"billingId" : {
"type" : "integer",
"format" : "int64"
},
"accountName" : {
"type" : "string"
},
"available" : {
"type" : "boolean",
"default" : false
},
"details" : {
"$ref" : "#/definitions/RegionDetails"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"jurisdiction" : {
"type" : "string",
"enum" : [ "AU", "BR", "CA", "CH", "CN", "DE", "HK", "IN", "JP", "EU", "US", "SG", "IL", "MX", "KR", "RU", "TW", "ZA", "OTHER" ]
},
"name" : {
"type" : "string"
},
"providerRegionId" : {
"type" : "string"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"subscription" : {
"$ref" : "#/definitions/RegionSubscriptionDescription"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"id" : {
"type" : "string"
}
}
},
"CatalogDescription" : {
"type" : "object",
"properties" : {
"catalogId" : {
"type" : "integer",
"format" : "int64"
},
"enstratusCustomerId" : {
"type" : "integer",
"format" : "int64"
},
"blueprints" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"$ref" : "#/definitions/BlueprintSummary"
}
},
"active" : {
"type" : "boolean",
"default" : false
},
"displayName" : {
"type" : "string"
},
"ownerName" : {
"type" : "string"
},
"ownerEmail" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"publicCatalog" : {
"type" : "boolean",
"default" : false
}
}
},
"PrepaymentDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"assignable" : {
"type" : "boolean",
"default" : false
},
"billingId" : {
"type" : "integer",
"format" : "int64"
},
"billingCodePreferences" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"currencyCode" : {
"type" : "string"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"details" : {
"$ref" : "#/definitions/PrepaymentDetails"
},
"expirationTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"fixedFee" : {
"type" : "number",
"format" : "float"
},
"hourlyFee" : {
"type" : "number",
"format" : "float"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"periodInDays" : {
"type" : "integer",
"format" : "int32"
},
"periodStartTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"providerProductId" : {
"type" : "string"
},
"prepaymentId" : {
"type" : "integer",
"format" : "int64"
},
"providerPrepaymentId" : {
"type" : "string"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"regionName" : {
"type" : "string"
},
"resourceLocator" : {
"type" : "string"
},
"serverCount" : {
"type" : "integer",
"format" : "int32"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"zoneName" : {
"type" : "string"
}
}
},
"DeploymentRequirementsDetails" : {
"type" : "object",
"properties" : {
"deploymentTarget" : {
"$ref" : "#/definitions/DeploymentDescription"
},
"deploymentTemplate" : {
"$ref" : "#/definitions/DeploymentDescription"
}
}
},
"ZoneDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"available" : {
"type" : "boolean",
"default" : false
},
"name" : {
"type" : "string"
},
"providerZoneId" : {
"type" : "string"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"id" : {
"type" : "string"
}
}
},
"ConfigurationManagementAccountDetails" : {
"type" : "object",
"properties" : {
"budget" : {
"$ref" : "#/definitions/BillingCodeDescription"
},
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
},
"owningGroup" : {
"$ref" : "#/definitions/GroupDescription"
},
"owningUser" : {
"$ref" : "#/definitions/UserDescription"
},
"service" : {
"$ref" : "#/definitions/ConfigurationManagementServiceDescription"
}
}
},
"CatalogCmd" : {
"type" : "object",
"required" : [ "customerId" ],
"properties" : {
"errorsStr" : {
"type" : "string"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"catalogId" : {
"type" : "integer",
"format" : "int64"
},
"catalogName" : {
"type" : "string"
},
"catalogOwner" : {
"type" : "string"
},
"catalogOwnerEmail" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
},
"RunListComponent" : {
"type" : "object",
"properties" : {
"componentId" : {
"type" : "integer",
"format" : "int64"
},
"type" : {
"type" : "string",
"enum" : [ "SCRIPT", "PERSONALITY", "PARAMETER" ]
},
"providerId" : {
"type" : "string"
}
}
},
"CloudDescription" : {
"type" : "object",
"properties" : {
"accountLabel" : {
"type" : "string"
},
"apiIdLabel" : {
"type" : "string"
},
"apiSecretLabel" : {
"type" : "string"
},
"apiStatus" : {
"type" : "string"
},
"available" : {
"type" : "boolean",
"default" : false
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"computeStatus" : {
"type" : "string"
},
"delegate" : {
"type" : "string"
},
"endpoint" : {
"type" : "string"
},
"keyInfoText" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"networkStatus" : {
"type" : "string"
},
"ownerId" : {
"type" : "integer",
"format" : "int64"
},
"providerLogoUrl" : {
"type" : "string"
},
"providerName" : {
"type" : "string"
},
"providerStatusUrl" : {
"type" : "string"
},
"providerWebUrl" : {
"type" : "string"
},
"storageAccountLabel" : {
"type" : "string"
},
"storageApiIdLabel" : {
"type" : "string"
},
"storageApiSecretLabel" : {
"type" : "string"
},
"storageDelegate" : {
"type" : "string"
},
"storageEndpoint" : {
"type" : "string"
},
"storageStatus" : {
"type" : "string"
},
"storageX509CertLabel" : {
"type" : "string"
},
"storageX509KeyLabel" : {
"type" : "string"
},
"x509CertLabel" : {
"type" : "string"
},
"x509KeyLabel" : {
"type" : "string"
},
"storagePkcs12CertLabel" : {
"type" : "string"
},
"storagePkcs12PasswordLabel" : {
"type" : "string"
},
"pkcs12CertLabel" : {
"type" : "string"
},
"pkcs12PasswordLabel" : {
"type" : "string"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"privateCloud" : {
"type" : "boolean",
"default" : false
},
"ok" : {
"type" : "boolean",
"default" : false
}
}
},
"BlueprintSummary" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"activeVersion" : {
"type" : "boolean",
"default" : false
},
"activeVersionLabel" : {
"type" : "string"
},
"blueprintId" : {
"type" : "integer",
"format" : "int64"
},
"catalogId" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"longDescription" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"defaultPlatform" : {
"type" : "string",
"enum" : [ "UNIX", "UBUNTU", "DEBIAN", "SOLARIS", "FEDORA_CORE", "RHEL", "FREE_BSD", "OPEN_BSD", "CENT_OS", "COREOS", "WINDOWS", "SUSE", "SMARTOS", "UNKNOWN" ]
},
"defaultArchitecture" : {
"type" : "string",
"enum" : [ "I32", "I64", "POWER", "SPARC" ]
},
"base64EncodedIcon" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "AGENT_1", "DOCKER_1", "MULTI_TIER_1" ]
},
"createdBy" : {
"type" : "string"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"groups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"updatedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"version" : {
"type" : "string"
},
"author" : {
"type" : "string"
},
"parentBlueprintId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"GroupDTO" : {
"type" : "object",
"properties" : {
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"customerName" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"directoryServiceId" : {
"type" : "integer",
"format" : "int64"
},
"enstratusGroupId" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"admin" : {
"type" : "boolean",
"default" : false
},
"customerAdmin" : {
"type" : "boolean",
"default" : false
},
"userAdmin" : {
"type" : "boolean",
"default" : false
},
"catalogAdmin" : {
"type" : "boolean",
"default" : false
},
"configurationManagementAdmin" : {
"type" : "boolean",
"default" : false
},
"configurationManagementQualifier" : {
"type" : "string",
"enum" : [ "ANY", "GROUP", "MINE" ]
},
"providerGroupId" : {
"type" : "string"
},
"editable" : {
"type" : "boolean",
"default" : false
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"externallyManaged" : {
"type" : "boolean",
"default" : false
},
"externalServiceType" : {
"type" : "string",
"enum" : [ "LDAP", "SERVICE_NOW" ]
},
"roleAssignments" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RoleAssignmentDTO"
}
}
},
"xml" : {
"name" : "group"
}
},
"RoleInfo" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"minDegree" : {
"type" : "integer",
"format" : "int32"
},
"maxDegree" : {
"type" : "integer",
"format" : "int32"
},
"refMBeanClassName" : {
"type" : "string"
},
"readable" : {
"type" : "boolean",
"default" : false
},
"writable" : {
"type" : "boolean",
"default" : false
}
}
},
"IpForwardingRule" : {
"type" : "object",
"properties" : {
"addressId" : {
"type" : "string"
},
"privatePort" : {
"type" : "integer",
"format" : "int32"
},
"protocol" : {
"type" : "string",
"enum" : [ "TCP", "UDP", "ICMP", "IPSEC", "ANY" ]
},
"providerRuleId" : {
"type" : "string"
},
"publicPort" : {
"type" : "integer",
"format" : "int32"
},
"serverId" : {
"type" : "string"
}
}
},
"Number" : {
"type" : "object"
},
"BillingCodeDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"billable" : {
"type" : "boolean",
"default" : false
},
"billingCodeId" : {
"type" : "integer",
"format" : "int64"
},
"budgetState" : {
"type" : "string",
"enum" : [ "NORMAL", "SOFT_ALARM", "HARD_ALARM" ]
},
"currency" : {
"type" : "string"
},
"currentUsage" : {
"type" : "number",
"format" : "float"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"customerName" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"financeCode" : {
"type" : "string"
},
"hardQuota" : {
"type" : "number",
"format" : "float"
},
"name" : {
"type" : "string"
},
"projectedUsage" : {
"type" : "number",
"format" : "float"
},
"runRate" : {
"type" : "number",
"format" : "float"
},
"softQuota" : {
"type" : "number",
"format" : "float"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
}
},
"xml" : {
"name" : "billingCodeDescription"
}
},
"ProgressDescription" : {
"type" : "object",
"properties" : {
"createTime" : {
"type" : "integer",
"format" : "int64"
},
"steps" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/StepDescription"
}
},
"state" : {
"type" : "string",
"enum" : [ "PENDING", "RUNNING_BETWEEN_STEPS", "RUNNING_STEP", "COMPLETED", "FAILED" ]
},
"failure" : {
"type" : "string"
},
"failureStack" : {
"type" : "string"
},
"result" : {
"type" : "string"
},
"currentStep" : {
"$ref" : "#/definitions/StepDescription"
},
"currentStepIsRepeat" : {
"type" : "boolean",
"default" : false
}
}
},
"Gigabyte" : {
"type" : "object",
"properties" : {
"baseUnitConversion" : {
"type" : "number",
"format" : "double"
},
"baseUnit" : {
"$ref" : "#/definitions/UnitOfMeasure"
}
}
},
"AddUpdateUserGroupCmd" : {
"type" : "object",
"properties" : {
"errorsStr" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"admin" : {
"type" : "boolean",
"default" : false
},
"customerAdmin" : {
"type" : "boolean",
"default" : false
},
"userAdmin" : {
"type" : "boolean",
"default" : false
},
"catalogAdmin" : {
"type" : "boolean",
"default" : false
},
"configurationManagementAdmin" : {
"type" : "boolean",
"default" : false
},
"configurationManagementQualifier" : {
"type" : "string",
"enum" : [ "ANY", "GROUP", "MINE" ]
},
"customerBillingRoleIdsToAdd" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"format" : "int64"
}
},
"customerBillingRoleIdsToRemove" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"format" : "int64"
}
},
"customerBillingBudgetCodeIdsToAdd" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "integer",
"format" : "int64"
}
}
},
"customerBillingBudgetCodeIdsToRemove" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "integer",
"format" : "int64"
}
}
}
},
"xml" : {
"name" : "addUpdateUserGroupCmd"
}
},
"StepDescription" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"state" : {
"type" : "string",
"enum" : [ "RUNNING", "COMPLETED", "INTERRUPTED", "FAILED", "SKIPPED", "PENDING", "CONDITIONAL" ]
},
"outcome" : {
"type" : "string"
},
"warnings" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"startTime" : {
"type" : "integer",
"format" : "int64"
},
"endTime" : {
"type" : "integer",
"format" : "int64"
}
}
},
"DeploymentDetails" : {
"type" : "object",
"properties" : {
"drStorageRegion" : {
"$ref" : "#/definitions/RegionDescription"
},
"loadBalancers" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DeploymentLoadBalancerDescription"
}
},
"requirements" : {
"$ref" : "#/definitions/DeploymentRequirementsDescription"
},
"stats" : {
"$ref" : "#/definitions/DeploymentStatsDescription"
},
"catalogItem" : {
"$ref" : "#/definitions/DeploymentDescription"
},
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
}
}
},
"RoleAssignmentDTO" : {
"type" : "object",
"properties" : {
"billingId" : {
"type" : "integer",
"format" : "int64"
},
"roleId" : {
"type" : "integer",
"format" : "int64"
}
},
"xml" : {
"name" : "roleAssignment"
}
},
"ConfigurationManagementAccountDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"accountNumber" : {
"type" : "string"
},
"details" : {
"$ref" : "#/definitions/ConfigurationManagementAccountDetails"
},
"resourceLocator" : {
"type" : "string"
},
"serviceId" : {
"type" : "integer",
"format" : "int64"
},
"system" : {
"type" : "string"
},
"systemId" : {
"type" : "integer",
"format" : "int64"
},
"endpoint" : {
"type" : "string"
},
"publicAccountApiKey" : {
"type" : "string"
},
"publicClientApiKey" : {
"type" : "string"
},
"lastModified" : {
"type" : "integer",
"format" : "int64"
}
}
},
"ImageDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"customerBillingId" : {
"type" : "integer",
"format" : "int64"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"hasShadow" : {
"type" : "boolean",
"default" : false
},
"shadowState" : {
"type" : "string"
},
"shadowDescription" : {
"type" : "string"
},
"agentVersion" : {
"type" : "integer",
"format" : "int32"
},
"architecture" : {
"type" : "string",
"enum" : [ "I32", "I64", "POWER", "SPARC" ]
},
"available" : {
"type" : "boolean",
"default" : false
},
"financeCode" : {
"type" : "string"
},
"billingCodeName" : {
"type" : "string"
},
"cloudName" : {
"type" : "string"
},
"deprecated" : {
"type" : "boolean",
"default" : false
},
"imageId" : {
"type" : "integer",
"format" : "int64"
},
"owner" : {
"type" : "string"
},
"ownerIdString" : {
"type" : "string"
},
"ownerName" : {
"type" : "string"
},
"ownerAccountId" : {
"type" : "integer",
"format" : "int64"
},
"ownerAccountName" : {
"type" : "string"
},
"ownerCloudAccountNumber" : {
"type" : "string"
},
"ownerEnstratusAccountId" : {
"type" : "integer",
"format" : "int64"
},
"ownerBillingId" : {
"type" : "integer",
"format" : "int64"
},
"ownerNetworkId" : {
"type" : "integer",
"format" : "int64"
},
"platform" : {
"type" : "string"
},
"providerImageId" : {
"type" : "string"
},
"publicShare" : {
"type" : "boolean",
"default" : false
},
"registered" : {
"type" : "boolean",
"default" : false
},
"removeable" : {
"type" : "boolean",
"default" : false
},
"serverGroupId" : {
"type" : "integer",
"format" : "int64"
},
"shareable" : {
"type" : "boolean",
"default" : false
},
"size" : {
"type" : "string"
},
"userGroupName" : {
"type" : "string"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"hasWindowsProductKey" : {
"type" : "boolean",
"default" : false
},
"windowsProductKeyRequired" : {
"type" : "boolean",
"default" : false
},
"userGroupId" : {
"type" : "integer",
"format" : "int64"
},
"creationDate" : {
"type" : "string",
"format" : "date-time"
},
"creationTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"billingCodeId" : {
"type" : "integer",
"format" : "int64"
},
"billingId" : {
"type" : "integer",
"format" : "int64"
},
"id" : {
"type" : "string"
}
}
},
"ServerDetails" : {
"type" : "object",
"properties" : {
"account" : {
"$ref" : "#/definitions/AccountDescription"
},
"billing" : {
"$ref" : "#/definitions/BillingDescription"
},
"budget" : {
"$ref" : "#/definitions/BillingCodeDescription"
},
"cloud" : {
"$ref" : "#/definitions/CloudDescription"
},
"cmAccount" : {
"$ref" : "#/definitions/ConfigurationManagementAccountDescription"
},
"cmClientName" : {
"type" : "string"
},
"currentAnalytics" : {
"$ref" : "#/definitions/ServerAnalyticsDataPoint"
},
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
},
"deployment" : {
"$ref" : "#/definitions/DeploymentDescription"
},
"devices" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DeviceMapping"
}
},
"environment" : {
"$ref" : "#/definitions/EnvironmentDescription"
},
"eventLog" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/EventDescription"
}
},
"lastAgentContactTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastStateChangeId" : {
"type" : "integer",
"format" : "int64"
},
"machineImage" : {
"$ref" : "#/definitions/ImageDescription"
},
"network" : {
"$ref" : "#/definitions/NetworkDescription"
},
"operationalState" : {
"type" : "string",
"enum" : [ "NORMAL", "MAINTENANCE", "IMPAIRED", "DOWN" ]
},
"owningGroup" : {
"$ref" : "#/definitions/GroupDescription"
},
"owningUser" : {
"$ref" : "#/definitions/UserDescription"
},
"parameterList" : {
"type" : "string"
},
"prepayment" : {
"$ref" : "#/definitions/PrepaymentDescription"
},
"product" : {
"$ref" : "#/definitions/ServerProductDescription"
},
"region" : {
"$ref" : "#/definitions/RegionDescription"
},
"resourceState" : {
"type" : "string",
"enum" : [ "UNDER_UTILIZED", "OVER_UTILIZED", "NORMAL" ]
},
"runList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RunListComponent"
}
},
"subnet" : {
"$ref" : "#/definitions/SubnetDescription"
},
"endpoints" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ForwardingRuleDescription"
}
},
"lastContactTimestamp" : {
"type" : "integer",
"format" : "int64"
}
}
},
"NetworkDetails" : {
"type" : "object",
"properties" : {
"account" : {
"$ref" : "#/definitions/AccountDescription"
},
"billing" : {
"$ref" : "#/definitions/BillingDescription"
},
"budget" : {
"$ref" : "#/definitions/BillingCodeDescription"
},
"cloud" : {
"$ref" : "#/definitions/CloudDescription"
},
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
},
"dataCenter" : {
"$ref" : "#/definitions/ZoneDescription"
},
"owningGroup" : {
"$ref" : "#/definitions/GroupDescription"
},
"owningUser" : {
"$ref" : "#/definitions/UserDescription"
},
"region" : {
"$ref" : "#/definitions/RegionDescription"
},
"subnets" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SubnetDescription"
}
}
}
},
"AccountDescription" : {
"type" : "object",
"properties" : {
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"accountNumber" : {
"type" : "string"
},
"accountStatus" : {
"type" : "string"
},
"active" : {
"type" : "boolean",
"default" : false
},
"alertInterval" : {
"type" : "integer",
"format" : "int32"
},
"allowIndividualEmailAlerts" : {
"type" : "boolean",
"default" : false
},
"allowIndividualSmsAlerts" : {
"type" : "boolean",
"default" : false
},
"automatedDnsTtl" : {
"type" : "integer",
"format" : "int32"
},
"automatedDnsZoneId" : {
"type" : "integer",
"format" : "int64"
},
"billingId" : {
"type" : "integer",
"format" : "int64"
},
"billingSystemId" : {
"type" : "string"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"cloudName" : {
"type" : "string"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"creditCardMask" : {
"type" : "string"
},
"directBill" : {
"type" : "boolean",
"default" : false
},
"globalEmailTarget" : {
"type" : "string"
},
"globalEmailThreshold" : {
"type" : "integer",
"format" : "int32"
},
"globalSmsTarget" : {
"type" : "string"
},
"globalSmsThreshold" : {
"type" : "integer",
"format" : "int32"
},
"managedBilling" : {
"type" : "boolean",
"default" : false
},
"meteredBilling" : {
"type" : "boolean",
"default" : false
},
"notificationTargetId" : {
"type" : "integer",
"format" : "int64"
},
"provisioned" : {
"type" : "boolean",
"default" : false
},
"pricingPlanId" : {
"type" : "integer",
"format" : "int64"
},
"pricingPlanName" : {
"type" : "string"
},
"primaryStorageRegionId" : {
"type" : "integer",
"format" : "int64"
},
"primaryStorageRegionProviderId" : {
"type" : "string"
},
"primaryStorageRegionName" : {
"type" : "string"
},
"primaryStorageCloudId" : {
"type" : "integer",
"format" : "int64"
},
"primaryStorageCloudName" : {
"type" : "string"
},
"stopAlertsAfterMinutes" : {
"type" : "integer",
"format" : "int32"
},
"subscription" : {
"$ref" : "#/definitions/CloudSubscriptionDescription"
},
"storageAccountNumber" : {
"type" : "string"
},
"accountName" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"defaultBillingCode" : {
"$ref" : "#/definitions/BillingCodeDescription"
},
"userBillingCodes" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BillingCodeDescription"
}
},
"resoldAccount" : {
"type" : "boolean",
"default" : false
},
"subscriptionsDiscovered" : {
"type" : "boolean",
"default" : false
},
"capabilities" : {
"$ref" : "#/definitions/CloudCapability"
},
"id" : {
"type" : "string"
}
}
},
"ConfigurationManagementServiceDetails" : {
"type" : "object",
"properties" : {
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
},
"system" : {
"$ref" : "#/definitions/ConfigurationManagementSystemDescription"
}
}
},
"BillingDescription" : {
"type" : "object",
"properties" : {
"accountName" : {
"type" : "string"
},
"accountStatus" : {
"type" : "string"
},
"alertIntervalInMinutes" : {
"type" : "integer",
"format" : "int32"
},
"allowIndividualEmailAlerts" : {
"type" : "boolean",
"default" : false
},
"allowIndividualSmsAlerts" : {
"type" : "boolean",
"default" : false
},
"billingId" : {
"type" : "integer",
"format" : "int64"
},
"billingSystemId" : {
"type" : "string"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"cloudAccountId" : {
"type" : "integer",
"format" : "int64"
},
"cloudAccountNumber" : {
"type" : "string"
},
"creditCardMask" : {
"type" : "string"
},
"configured" : {
"type" : "boolean",
"default" : false
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"defaultBillingCodeId" : {
"type" : "integer",
"format" : "int64"
},
"globalEmailTarget" : {
"type" : "string"
},
"globalEmailThreshold" : {
"type" : "integer",
"format" : "int32"
},
"globalSmsTarget" : {
"type" : "string"
},
"globalSmsThreshold" : {
"type" : "integer",
"format" : "int32"
},
"managedBilling" : {
"type" : "boolean",
"default" : false
},
"meteredBilling" : {
"type" : "boolean",
"default" : false
},
"notificationTargetId" : {
"type" : "integer",
"format" : "int64"
},
"pricingPlanId" : {
"type" : "integer",
"format" : "int64"
},
"primaryStorage" : {
"type" : "integer",
"format" : "int64"
},
"provisioned" : {
"type" : "boolean",
"default" : false
},
"stopAlertsAfterMinutes" : {
"type" : "integer",
"format" : "int32"
},
"subscribed" : {
"type" : "boolean",
"default" : false
}
}
},
"DeviceMapping" : {
"type" : "object",
"properties" : {
"deviceId" : {
"type" : "string"
},
"encrypted" : {
"type" : "boolean",
"default" : false
},
"fileSystem" : {
"type" : "string"
},
"mountPoint" : {
"type" : "string"
},
"size" : {
"type" : "integer",
"format" : "int64"
},
"used" : {
"type" : "integer",
"format" : "int64"
},
"type" : {
"type" : "string",
"enum" : [ "ROOT", "EPHEMERAL", "SERVICE", "CUSTOM" ]
}
}
},
"JobDescription" : {
"type" : "object",
"properties" : {
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"userId" : {
"type" : "integer",
"format" : "int64"
},
"userName" : {
"type" : "string"
},
"taskType" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"jobId" : {
"type" : "integer",
"format" : "int64"
},
"jobStatus" : {
"type" : "string"
},
"progress" : {
"$ref" : "#/definitions/ProgressDescription"
},
"message" : {
"type" : "string"
},
"results" : {
"$ref" : "#/definitions/TaskResults"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"invisible" : {
"type" : "boolean",
"default" : false
},
"visible" : {
"type" : "boolean",
"default" : false
},
"id" : {
"type" : "string"
}
}
},
"StorageMegabyte" : {
"type" : "object",
"properties" : {
"quantity" : {
"$ref" : "#/definitions/Number"
},
"unitOfMeasure" : {
"$ref" : "#/definitions/Megabyte"
}
}
},
"RegionDetails" : {
"type" : "object",
"properties" : {
"account" : {
"$ref" : "#/definitions/AccountDescription"
},
"billing" : {
"$ref" : "#/definitions/BillingDescription"
},
"cloud" : {
"$ref" : "#/definitions/CloudDescription"
},
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
},
"subscription" : {
"$ref" : "#/definitions/RegionSubscriptionDescription"
}
}
},
"Megabyte" : {
"type" : "object",
"properties" : {
"baseUnitConversion" : {
"type" : "number",
"format" : "double"
},
"baseUnit" : {
"$ref" : "#/definitions/UnitOfMeasure"
}
}
},
"Action" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"enabled" : {
"type" : "boolean",
"default" : false
},
"reason" : {
"type" : "string"
}
}
},
"UnitOfMeasure" : {
"type" : "object",
"properties" : {
"baseUnitConversion" : {
"type" : "number",
"format" : "double"
},
"baseUnit" : {
"$ref" : "#/definitions/UnitOfMeasure"
}
}
},
"ServerAnalyticsDataPoint" : {
"type" : "object",
"properties" : {
"agentCpuLoad" : {
"type" : "number",
"format" : "float"
},
"agentCpuUtilization" : {
"type" : "number",
"format" : "float"
},
"agentProcesses" : {
"type" : "integer",
"format" : "int32"
},
"agentResponseTimeInMillis" : {
"type" : "integer",
"format" : "int32"
},
"cpuCount" : {
"type" : "integer",
"format" : "int32"
},
"cpuUtilizationAverage" : {
"type" : "number",
"format" : "float"
},
"cpuUtilizationMaximum" : {
"type" : "number",
"format" : "float"
},
"cpuUtilizationMinimum" : {
"type" : "number",
"format" : "float"
},
"currentRam" : {
"type" : "integer",
"format" : "int32"
},
"dataPointTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"dayOfMonth" : {
"type" : "integer",
"format" : "int32"
},
"diskReadBytesAverage" : {
"type" : "number",
"format" : "double"
},
"diskReadBytesMaximum" : {
"type" : "number",
"format" : "double"
},
"diskReadBytesMinimum" : {
"type" : "number",
"format" : "double"
},
"diskReadOpsAverage" : {
"type" : "number",
"format" : "double"
},
"diskReadOpsMaximum" : {
"type" : "number",
"format" : "double"
},
"diskReadOpsMinimum" : {
"type" : "number",
"format" : "double"
},
"diskWriteBytesAverage" : {
"type" : "number",
"format" : "double"
},
"diskWriteBytesMaximum" : {
"type" : "number",
"format" : "double"
},
"diskWriteBytesMinimum" : {
"type" : "number",
"format" : "double"
},
"diskWriteOpsAverage" : {
"type" : "number",
"format" : "double"
},
"diskWriteOpsMaximum" : {
"type" : "number",
"format" : "double"
},
"diskWriteOpsMinimum" : {
"type" : "number",
"format" : "double"
},
"hour" : {
"type" : "integer",
"format" : "int32"
},
"maximumRam" : {
"type" : "integer",
"format" : "int32"
},
"minute" : {
"type" : "integer",
"format" : "int32"
},
"month" : {
"type" : "integer",
"format" : "int32"
},
"networkInAverage" : {
"type" : "number",
"format" : "double"
},
"networkInMaximum" : {
"type" : "number",
"format" : "double"
},
"networkInMinimum" : {
"type" : "number",
"format" : "double"
},
"networkOutAverage" : {
"type" : "number",
"format" : "double"
},
"networkOutMaximum" : {
"type" : "number",
"format" : "double"
},
"networkOutMinimum" : {
"type" : "number",
"format" : "double"
},
"operationalState" : {
"type" : "string",
"enum" : [ "NORMAL", "MAINTENANCE", "IMPAIRED", "DOWN" ]
},
"resourceState" : {
"type" : "string",
"enum" : [ "UNDER_UTILIZED", "OVER_UTILIZED", "NORMAL" ]
},
"year" : {
"type" : "integer",
"format" : "int32"
}
}
},
"UserSummary" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"alphaName" : {
"type" : "string"
},
"cloudAccountAccess" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AccountAccessSummary"
}
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"enstratusUserId" : {
"type" : "integer",
"format" : "int64"
},
"groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/GroupDescription"
}
},
"passwordResetAllowed" : {
"type" : "boolean",
"default" : false
},
"sshPublicKey" : {
"type" : "string"
},
"userId" : {
"type" : "string"
},
"personId" : {
"type" : "integer",
"format" : "int64"
},
"externallyManaged" : {
"type" : "boolean",
"default" : false
},
"externalServiceType" : {
"type" : "string",
"enum" : [ "LDAP", "SERVICE_NOW" ]
},
"emailVerified" : {
"type" : "boolean",
"default" : false
},
"smsVerified" : {
"type" : "boolean",
"default" : false
},
"voiceVerified" : {
"type" : "boolean",
"default" : false
},
"previousLoginTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"hasWindowsCredentials" : {
"type" : "boolean",
"default" : false
},
"firstName" : {
"type" : "string"
},
"lastName" : {
"type" : "string"
},
"emailAddress" : {
"type" : "string"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
}
},
"xml" : {
"name" : "userSummary"
}
},
"FirewallRuleDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"customerBillingId" : {
"type" : "integer",
"format" : "int64"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"hasShadow" : {
"type" : "boolean",
"default" : false
},
"shadowState" : {
"type" : "string"
},
"shadowDescription" : {
"type" : "string"
},
"firewallObject" : {
"$ref" : "#/definitions/FirewallDescription"
},
"allowed" : {
"type" : "boolean",
"default" : false
},
"destinationId" : {
"type" : "string"
},
"destinationType" : {
"type" : "string",
"enum" : [ "GLOBAL", "VLAN", "VM", "CIDR" ]
},
"endPort" : {
"type" : "integer",
"format" : "int32"
},
"firewallId" : {
"type" : "integer",
"format" : "int64"
},
"firewallRuleId" : {
"type" : "integer",
"format" : "int64"
},
"ingressRule" : {
"type" : "boolean",
"default" : false
},
"precedence" : {
"type" : "integer",
"format" : "int32"
},
"protocol" : {
"type" : "string",
"enum" : [ "TCP", "UDP", "ICMP", "IPSEC", "ANY" ]
},
"providerFirewallRuleId" : {
"type" : "string"
},
"serviceName" : {
"type" : "string"
},
"sourceId" : {
"type" : "string"
},
"sourceType" : {
"type" : "string",
"enum" : [ "GLOBAL", "VLAN", "VM", "CIDR" ]
},
"startPort" : {
"type" : "integer",
"format" : "int32"
},
"sourceName" : {
"type" : "string"
},
"destName" : {
"type" : "string"
},
"method" : {
"type" : "string"
},
"firewall" : {
"type" : "integer",
"format" : "int64"
},
"ownerId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"AddUpdateUserCmd" : {
"type" : "object",
"properties" : {
"errorsStr" : {
"type" : "string"
},
"groupIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"firstName" : {
"type" : "string"
},
"lastName" : {
"type" : "string"
},
"password" : {
"type" : "string"
},
"sshKey" : {
"type" : "string"
},
"windowsPassword" : {
"type" : "string"
}
},
"xml" : {
"name" : "addUpdateUserCmd"
}
},
"CloudCapability" : {
"type" : "object",
"properties" : {
"launchServerCapabilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"createImageCapabilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"createVolumeCapabilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"createFirewallCapabilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"launchLoadBalancerCapabilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"createRelationalDatabaseCapabilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"createSubnetCapabilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
},
"SubnetDetails" : {
"type" : "object",
"properties" : {
"account" : {
"$ref" : "#/definitions/AccountDescription"
},
"billing" : {
"$ref" : "#/definitions/BillingDescription"
},
"budget" : {
"$ref" : "#/definitions/BillingCodeDescription"
},
"cloud" : {
"$ref" : "#/definitions/CloudDescription"
},
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
},
"dataCenter" : {
"$ref" : "#/definitions/ZoneDescription"
},
"network" : {
"$ref" : "#/definitions/NetworkDescription"
},
"owningGroup" : {
"$ref" : "#/definitions/GroupDescription"
},
"owningUser" : {
"$ref" : "#/definitions/UserDescription"
},
"region" : {
"$ref" : "#/definitions/RegionDescription"
}
}
},
"ConfigurationManagementSystemDescription" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"details" : {
"$ref" : "#/definitions/ConfigurationManagementSystemDetails"
},
"logoUrl" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"openSource" : {
"type" : "boolean",
"default" : false
},
"owningCustomerId" : {
"type" : "integer",
"format" : "int64"
},
"propertyNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"systemDelegate" : {
"type" : "string"
},
"systemId" : {
"type" : "integer",
"format" : "int64"
},
"type" : {
"type" : "string",
"enum" : [ "CHEF", "PUPPET", "ENSTRATUS" ]
},
"vendor" : {
"type" : "string"
},
"publicSystem" : {
"type" : "boolean",
"default" : false
}
}
},
"CloudSubscriptionDescription" : {
"type" : "object",
"properties" : {
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"customImagesSupported" : {
"type" : "boolean",
"default" : false
},
"firewallCreationAllowed" : {
"type" : "boolean",
"default" : false
},
"globalFirewalls" : {
"type" : "boolean",
"default" : false
},
"globalNetworks" : {
"type" : "boolean",
"default" : false
},
"globalSnapshots" : {
"type" : "boolean",
"default" : false
},
"globalLoadBalancers" : {
"type" : "boolean",
"default" : false
},
"hypervisorAnalyticsSupported" : {
"type" : "boolean",
"default" : false
},
"ipAddressForwarding" : {
"type" : "boolean",
"default" : false
},
"loadBalancerAddressAssigned" : {
"type" : "boolean",
"default" : false
},
"loadBalancerDataCenterLimited" : {
"type" : "boolean",
"default" : false
},
"privateImageSharingSupported" : {
"type" : "boolean",
"default" : false
},
"privateIpAddressAssignable" : {
"type" : "boolean",
"default" : false
},
"privateIpAddressRequestable" : {
"type" : "boolean",
"default" : false
},
"privateSnapshotSharingSupported" : {
"type" : "boolean",
"default" : false
},
"publicImageSharingSupported" : {
"type" : "boolean",
"default" : false
},
"publicIpAddressAssignable" : {
"type" : "boolean",
"default" : false
},
"publicIpAddressRequestable" : {
"type" : "boolean",
"default" : false
},
"publicLibraryAvailable" : {
"type" : "boolean",
"default" : false
},
"publicSnapshotSharingSupported" : {
"type" : "boolean",
"default" : false
},
"rdbmsFirewalled" : {
"type" : "boolean",
"default" : false
},
"rdbmsHighAvailability" : {
"type" : "boolean",
"default" : false
},
"rdbmsLowAvailability" : {
"type" : "boolean",
"default" : false
},
"rdbmsMaintenance" : {
"type" : "boolean",
"default" : false
},
"rdbmsSnapshots" : {
"type" : "boolean",
"default" : false
},
"shellKeyBootstrapped" : {
"type" : "boolean",
"default" : false
},
"subnetCreationAllowed" : {
"type" : "boolean",
"default" : false
},
"subscribedArchiveStore" : {
"type" : "boolean",
"default" : false
},
"subscribedAutoScaling" : {
"type" : "boolean",
"default" : false
},
"subscribedBlobStore" : {
"type" : "boolean",
"default" : false
},
"subscribedCdn" : {
"type" : "boolean",
"default" : false
},
"subscribedDns" : {
"type" : "boolean",
"default" : false
},
"subscribedEmail" : {
"type" : "boolean",
"default" : false
},
"subscribedFirewall" : {
"type" : "boolean",
"default" : false
},
"subscribedImage" : {
"type" : "boolean",
"default" : false
},
"subscribedIpAddress" : {
"type" : "boolean",
"default" : false
},
"subscribedKeyValueDatabase" : {
"type" : "boolean",
"default" : false
},
"subscribedLoadBalancer" : {
"type" : "boolean",
"default" : false
},
"subscribedMessageQueue" : {
"type" : "boolean",
"default" : false
},
"subscribedPushNotifications" : {
"type" : "boolean",
"default" : false
},
"subscribedRelationalDatabase" : {
"type" : "boolean",
"default" : false
},
"subscribedServer" : {
"type" : "boolean",
"default" : false
},
"subscribedSnapshot" : {
"type" : "boolean",
"default" : false
},
"subscribedVlan" : {
"type" : "boolean",
"default" : false
},
"subscribedVolume" : {
"type" : "boolean",
"default" : false
},
"subscribedVpn" : {
"type" : "boolean",
"default" : false
},
"vlanCreationAllowed" : {
"type" : "boolean",
"default" : false
},
"vlanDcConstrained" : {
"type" : "boolean",
"default" : false
},
"subnetDcConstrained" : {
"type" : "boolean",
"default" : false
},
"userDataSupported" : {
"type" : "boolean",
"default" : false
},
"loadBalancerMaxListeners" : {
"type" : "integer",
"format" : "int32"
},
"vmProductDcConstrained" : {
"type" : "boolean",
"default" : false
},
"serverClone" : {
"type" : "boolean",
"default" : false
},
"serverPause" : {
"type" : "boolean",
"default" : false
},
"serverReboot" : {
"type" : "boolean",
"default" : false
},
"serverResume" : {
"type" : "boolean",
"default" : false
},
"serverStart" : {
"type" : "boolean",
"default" : false
},
"serverStop" : {
"type" : "boolean",
"default" : false
},
"serverSuspend" : {
"type" : "boolean",
"default" : false
},
"serverUnpause" : {
"type" : "boolean",
"default" : false
},
"serverTerminate" : {
"type" : "boolean",
"default" : false
},
"lbCreateHcRequirement" : {
"type" : "string",
"enum" : [ "NONE", "OPTIONAL", "REQUIRED" ]
},
"deviceIdOnAttach" : {
"type" : "string",
"enum" : [ "NONE", "OPTIONAL", "REQUIRED" ]
}
}
},
"ConfigurationManagementSystemDetails" : {
"type" : "object",
"properties" : {
"owningCustomer" : {
"$ref" : "#/definitions/CustomerDescription"
}
}
},
"EnvironmentDetails" : {
"type" : "object",
"properties" : {
"account" : {
"$ref" : "#/definitions/ConfigurationManagementAccountDescription"
},
"budget" : {
"$ref" : "#/definitions/BillingCodeDescription"
},
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
},
"owningGroup" : {
"$ref" : "#/definitions/GroupDescription"
},
"owningUser" : {
"$ref" : "#/definitions/UserDescription"
}
}
},
"VMProduct" : {
"type" : "object",
"properties" : {
"cpuCount" : {
"type" : "integer",
"format" : "int32"
},
"description" : {
"type" : "string"
},
"rootVolumeSizeGB" : {
"type" : "number",
"format" : "double"
},
"name" : {
"type" : "string"
},
"providerProductId" : {
"type" : "string"
},
"ramSizeMB" : {
"type" : "number",
"format" : "double"
},
"standardHourlyRate" : {
"type" : "number",
"format" : "float"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"zonePredefined" : {
"type" : "boolean",
"default" : false
},
"ramSize" : {
"$ref" : "#/definitions/StorageMegabyte"
},
"rootVolumeSize" : {
"$ref" : "#/definitions/StorageGigabyte"
}
}
},
"DeploymentDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"backupWindow" : {
"$ref" : "#/definitions/ScheduledWindow"
},
"billingCode" : {
"$ref" : "#/definitions/BillingCodeDescription"
},
"deploymentState" : {
"type" : "string",
"enum" : [ "STOPPED", "PAUSED", "LAUNCHING", "RESUMING", "MAINTENANCE", "RUNNING", "PAUSING", "STOPPING", "IMPAIRED" ]
},
"deploymentType" : {
"type" : "string",
"enum" : [ "DEDICATED", "SHARED" ]
},
"catalogItemId" : {
"type" : "integer",
"format" : "int64"
},
"details" : {
"$ref" : "#/definitions/DeploymentDetails"
},
"drStorageId" : {
"type" : "integer",
"format" : "int64"
},
"deploymentId" : {
"type" : "integer",
"format" : "int64"
},
"forServiceCatalog" : {
"type" : "boolean",
"default" : false
},
"launchTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"maintenanceWindow" : {
"$ref" : "#/definitions/ScheduledWindow"
},
"owningGroup" : {
"$ref" : "#/definitions/GroupDescription"
},
"owningUser" : {
"$ref" : "#/definitions/UserDescription"
},
"reasonNotRemovable" : {
"type" : "string"
},
"removable" : {
"type" : "boolean",
"default" : false
},
"regions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RegionDescription"
}
},
"validForLaunch" : {
"type" : "boolean",
"default" : false
},
"withDetails" : {
"type" : "boolean",
"default" : false
},
"currentAlarmId" : {
"type" : "integer",
"format" : "int64"
},
"creationTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"billingCodeId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"ServerDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"customerBillingId" : {
"type" : "integer",
"format" : "int64"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"hasShadow" : {
"type" : "boolean",
"default" : false
},
"shadowState" : {
"type" : "string"
},
"shadowDescription" : {
"type" : "string"
},
"accountName" : {
"type" : "string"
},
"agentProxyId" : {
"type" : "integer",
"format" : "int64"
},
"agentVersion" : {
"type" : "integer",
"format" : "int32"
},
"agentStatus" : {
"type" : "string",
"enum" : [ "INITIAL_CONTACT", "INITIALIZED", "INITIALIZE_ERROR", "USERS_ADDED", "USERS_ADDED_ERROR", "DEVICES_SYNC", "DEVICES_SYNC_ERROR", "CM_FAILED", "CM_COMPLETE", "READY", "LOST" ]
},
"agentStatusMessage" : {
"type" : "string"
},
"analyticsEnabled" : {
"type" : "boolean",
"default" : false
},
"billingCodeName" : {
"type" : "string"
},
"cloudName" : {
"type" : "string"
},
"configurationManagementId" : {
"type" : "integer",
"format" : "int64"
},
"deployment" : {
"type" : "integer",
"format" : "int64"
},
"details" : {
"$ref" : "#/definitions/ServerDetails"
},
"environmentId" : {
"type" : "integer",
"format" : "int64"
},
"firewalls" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FirewallDescription"
}
},
"forImaging" : {
"type" : "boolean",
"default" : false
},
"imageable" : {
"type" : "boolean",
"default" : false
},
"impaired" : {
"type" : "boolean",
"default" : false
},
"machineImageId" : {
"type" : "integer",
"format" : "int64"
},
"machineImageName" : {
"type" : "string"
},
"networkId" : {
"type" : "integer",
"format" : "int64"
},
"owner" : {
"type" : "string"
},
"ownerAccountId" : {
"type" : "integer",
"format" : "int64"
},
"ownerName" : {
"type" : "string"
},
"pauseAfter" : {
"type" : "integer",
"format" : "int64"
},
"platform" : {
"type" : "string",
"enum" : [ "UNIX", "UBUNTU", "DEBIAN", "SOLARIS", "FEDORA_CORE", "RHEL", "FREE_BSD", "OPEN_BSD", "CENT_OS", "COREOS", "WINDOWS", "SUSE", "SMARTOS", "UNKNOWN" ]
},
"persistent" : {
"type" : "boolean",
"default" : false
},
"publicDnsName" : {
"type" : "string"
},
"publicIpAddress" : {
"type" : "string"
},
"prepaymentId" : {
"type" : "integer",
"format" : "int64"
},
"privateIpAddress" : {
"type" : "string"
},
"providerServerId" : {
"type" : "string"
},
"registered" : {
"type" : "boolean",
"default" : false
},
"requiresUpdate" : {
"type" : "boolean",
"default" : false
},
"reservedAddress" : {
"type" : "integer",
"format" : "int64"
},
"reservedIPAddress" : {
"type" : "string"
},
"securityGroupIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"securityGroupNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"serverGroupId" : {
"type" : "integer",
"format" : "int64"
},
"serverGroupName" : {
"type" : "string"
},
"privateDnsName" : {
"type" : "string"
},
"productId" : {
"type" : "integer",
"format" : "int64"
},
"providerProductId" : {
"type" : "string"
},
"cpuCount" : {
"type" : "integer",
"format" : "int32"
},
"ramInMb" : {
"type" : "integer",
"format" : "int32"
},
"serverId" : {
"type" : "integer",
"format" : "int64"
},
"serverRole" : {
"type" : "string"
},
"serverState" : {
"type" : "string"
},
"serverType" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"stopDate" : {
"type" : "string",
"format" : "date-time"
},
"terminationDate" : {
"type" : "string",
"format" : "date-time"
},
"subnetId" : {
"type" : "integer",
"format" : "int64"
},
"terminateAfter" : {
"type" : "integer",
"format" : "int64"
},
"uptime" : {
"type" : "integer",
"format" : "int64"
},
"userGroupName" : {
"type" : "string"
},
"zoneName" : {
"type" : "string"
},
"lastAgentContactTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"architecture" : {
"type" : "string"
},
"publicIpAddresses" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"privateIpAddresses" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"health" : {
"type" : "string",
"enum" : [ "NONFUNCTIONAL", "DEGRADED", "HEALTHY", "UNKNOWN" ]
},
"stackId" : {
"type" : "integer",
"format" : "int64"
},
"stackName" : {
"type" : "string"
},
"agentProxy" : {
"type" : "boolean",
"default" : false
},
"machineImageIdString" : {
"type" : "string"
},
"serverGroupIdString" : {
"type" : "string"
},
"zoneIdString" : {
"type" : "string"
},
"userGroupId" : {
"type" : "integer",
"format" : "int64"
},
"billingCode" : {
"type" : "string"
},
"billingCodeId" : {
"type" : "integer",
"format" : "int64"
},
"billingId" : {
"type" : "integer",
"format" : "int64"
},
"uptimeString" : {
"type" : "string"
},
"ownerId" : {
"type" : "integer",
"format" : "int64"
},
"id" : {
"type" : "string"
}
}
},
"UserDescription" : {
"type" : "object",
"properties" : {
"accountUserId" : {
"type" : "integer",
"format" : "int64"
},
"active" : {
"type" : "boolean",
"default" : false
},
"alertEmailTarget" : {
"type" : "string"
},
"alertSmsTarget" : {
"type" : "string"
},
"alertThreshold" : {
"type" : "integer",
"format" : "int32"
},
"alphaName" : {
"type" : "string"
},
"billingAccountId" : {
"type" : "integer",
"format" : "int64"
},
"billingCodeIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"directoryServiceId" : {
"type" : "integer",
"format" : "int64"
},
"editable" : {
"type" : "boolean",
"default" : false
},
"enstratusUserId" : {
"type" : "integer",
"format" : "int64"
},
"enstratusGroupIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"enstratusGroupNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"passwordResetAllowed" : {
"type" : "boolean",
"default" : false
},
"providerUserId" : {
"type" : "string"
},
"sshPublicKey" : {
"type" : "string"
},
"agentConsoleId" : {
"type" : "integer",
"format" : "int64"
},
"userId" : {
"type" : "string"
},
"hasConsoleAccess" : {
"type" : "boolean",
"default" : false
},
"hasApiAccess" : {
"type" : "boolean",
"default" : false
},
"consolePassword" : {
"type" : "string"
},
"apiPublicKey" : {
"type" : "string"
},
"apiSecretKey" : {
"type" : "string"
},
"hasWindowsCredentials" : {
"type" : "boolean",
"default" : false
},
"firstName" : {
"type" : "string"
},
"lastName" : {
"type" : "string"
},
"emailAddress" : {
"type" : "string"
},
"externallyManaged" : {
"type" : "boolean",
"default" : false
},
"previousLoginTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"latestLoginTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
}
},
"xml" : {
"name" : "userDescription"
}
},
"StorageGigabyte" : {
"type" : "object",
"properties" : {
"quantity" : {
"$ref" : "#/definitions/Number"
},
"unitOfMeasure" : {
"$ref" : "#/definitions/Gigabyte"
}
}
},
"AccountAccessSummary" : {
"type" : "object",
"properties" : {
"cloudAccountId" : {
"type" : "integer",
"format" : "int64"
},
"customerBillingId" : {
"type" : "integer",
"format" : "int64"
},
"accountName" : {
"type" : "string"
},
"billableBillingCodes" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"xml" : {
"name" : "accountAccessSummary"
}
},
"FirewallDetails" : {
"type" : "object",
"properties" : {
"account" : {
"$ref" : "#/definitions/AccountDescription"
},
"billing" : {
"$ref" : "#/definitions/BillingDescription"
},
"budget" : {
"$ref" : "#/definitions/BillingCodeDescription"
},
"cloud" : {
"$ref" : "#/definitions/CloudDescription"
},
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
},
"eventLog" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/EventDescription"
}
},
"network" : {
"$ref" : "#/definitions/NetworkDescription"
},
"owningGroup" : {
"$ref" : "#/definitions/GroupDescription"
},
"owningUser" : {
"$ref" : "#/definitions/UserDescription"
},
"rules" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FirewallRuleDescription"
}
}
}
},
"ForwardingRuleDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"customerBillingId" : {
"type" : "integer",
"format" : "int64"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"hasShadow" : {
"type" : "boolean",
"default" : false
},
"shadowState" : {
"type" : "string"
},
"shadowDescription" : {
"type" : "string"
},
"forwardingRuleId" : {
"type" : "integer",
"format" : "int64"
},
"forwardingAddress" : {
"type" : "string"
},
"forwardingAddressId" : {
"type" : "integer",
"format" : "int64"
},
"rule" : {
"$ref" : "#/definitions/IpForwardingRule"
},
"serverAddress" : {
"type" : "string"
},
"serverId" : {
"type" : "integer",
"format" : "int64"
},
"serverName" : {
"type" : "string"
},
"providerServerId" : {
"type" : "string"
},
"publicPort" : {
"type" : "integer",
"format" : "int32"
},
"privatePort" : {
"type" : "integer",
"format" : "int32"
},
"protocol" : {
"type" : "string",
"enum" : [ "TCP", "UDP", "ICMP", "IPSEC", "ANY" ]
}
}
},
"PrepaymentDetails" : {
"type" : "object",
"properties" : {
"billing" : {
"$ref" : "#/definitions/BillingDescription"
},
"cloud" : {
"$ref" : "#/definitions/CloudDescription"
},
"customer" : {
"$ref" : "#/definitions/CustomerDescription"
},
"dataCenter" : {
"$ref" : "#/definitions/ZoneDescription"
},
"owningGroup" : {
"$ref" : "#/definitions/GroupDescription"
},
"owningUser" : {
"$ref" : "#/definitions/UserDescription"
},
"region" : {
"$ref" : "#/definitions/RegionDescription"
}
}
},
"FirewallDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"customerBillingId" : {
"type" : "integer",
"format" : "int64"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"hasShadow" : {
"type" : "boolean",
"default" : false
},
"shadowState" : {
"type" : "string"
},
"shadowDescription" : {
"type" : "string"
},
"details" : {
"$ref" : "#/definitions/FirewallDetails"
},
"firewallId" : {
"type" : "integer",
"format" : "int64"
},
"networkId" : {
"type" : "integer",
"format" : "int64"
},
"networkName" : {
"type" : "string"
},
"providerFirewallId" : {
"type" : "string"
},
"resourceLocator" : {
"type" : "string"
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"health" : {
"type" : "string",
"enum" : [ "NONFUNCTIONAL", "DEGRADED", "HEALTHY", "UNKNOWN" ]
},
"stackId" : {
"type" : "integer",
"format" : "int64"
},
"stackName" : {
"type" : "string"
},
"userGroupId" : {
"type" : "integer",
"format" : "int64"
},
"providerSecurityGroupId" : {
"type" : "string"
},
"billingCodeId" : {
"type" : "integer",
"format" : "int64"
},
"billingId" : {
"type" : "integer",
"format" : "int64"
},
"ownerId" : {
"type" : "integer",
"format" : "int64"
},
"id" : {
"type" : "string"
}
}
},
"EnvironmentDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"accountName" : {
"type" : "string"
},
"details" : {
"$ref" : "#/definitions/EnvironmentDetails"
},
"environmentId" : {
"type" : "integer",
"format" : "int64"
},
"providerId" : {
"type" : "string"
},
"lastModified" : {
"type" : "integer",
"format" : "int64"
}
}
},
"ScheduledWindow" : {
"type" : "object",
"properties" : {
"daysOfWeekList" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ]
}
},
"endHour" : {
"type" : "integer",
"format" : "int32"
},
"endMinute" : {
"type" : "integer",
"format" : "int32"
},
"spansDays" : {
"type" : "boolean",
"default" : false
},
"startHour" : {
"type" : "integer",
"format" : "int32"
},
"startMinute" : {
"type" : "integer",
"format" : "int32"
},
"duration" : {
"type" : "integer",
"format" : "int64"
},
"inWindow" : {
"type" : "boolean",
"default" : false
}
}
},
"GroupDescription" : {
"type" : "object",
"properties" : {
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"customerName" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"directoryServiceId" : {
"type" : "integer",
"format" : "int64"
},
"enstratusGroupId" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"admin" : {
"type" : "boolean",
"default" : false
},
"customerAdmin" : {
"type" : "boolean",
"default" : false
},
"userAdmin" : {
"type" : "boolean",
"default" : false
},
"catalogAdmin" : {
"type" : "boolean",
"default" : false
},
"configurationManagementAdmin" : {
"type" : "boolean",
"default" : false
},
"configurationManagementQualifier" : {
"type" : "string",
"enum" : [ "ANY", "GROUP", "MINE" ]
},
"providerGroupId" : {
"type" : "string"
},
"editable" : {
"type" : "boolean",
"default" : false
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"externallyManaged" : {
"type" : "boolean",
"default" : false
},
"externalServiceType" : {
"type" : "string",
"enum" : [ "LDAP", "SERVICE_NOW" ]
}
},
"xml" : {
"name" : "groupDescription"
}
},
"CustomerDescription" : {
"type" : "object",
"properties" : {
"accountingCurrency" : {
"type" : "string"
},
"automatedExchangeRates" : {
"type" : "boolean",
"default" : false
},
"billingAddressId" : {
"type" : "integer",
"format" : "int64"
},
"billingCity" : {
"type" : "string"
},
"billingCountry" : {
"type" : "string"
},
"billingLineOne" : {
"type" : "string"
},
"billingLineTwo" : {
"type" : "string"
},
"billingLineThree" : {
"type" : "string"
},
"billingPostalCode" : {
"type" : "string"
},
"billingState" : {
"type" : "string"
},
"billingProvider" : {
"type" : "string"
},
"billingSystemId" : {
"type" : "string"
},
"billingPricingPlanId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"legalName" : {
"type" : "string"
},
"mainFax" : {
"type" : "string"
},
"mainPhone" : {
"type" : "string"
},
"parentResellerId" : {
"type" : "integer",
"format" : "int64"
},
"resellerURL" : {
"type" : "string"
},
"resellerUrlText" : {
"type" : "string"
},
"resellerWelcomeMsg" : {
"type" : "string"
},
"shortName" : {
"type" : "string"
},
"smsConfiguration" : {
"$ref" : "#/definitions/SmsConfiguration"
},
"supportURL" : {
"type" : "string"
},
"timeZone" : {
"type" : "string"
},
"webSite" : {
"type" : "string"
},
"freeUsageOnly" : {
"type" : "boolean",
"default" : false
},
"serverUsage" : {
"type" : "number",
"format" : "double"
},
"overFreeUsage" : {
"type" : "boolean",
"default" : false
},
"paymentMethod" : {
"type" : "string"
},
"resellAccountsAvailable" : {
"type" : "boolean",
"default" : false
},
"resellAccountsEnabled" : {
"type" : "boolean",
"default" : false
},
"freemium" : {
"type" : "boolean",
"default" : false
},
"suspended" : {
"type" : "boolean",
"default" : false
},
"externallyManaged" : {
"type" : "boolean",
"default" : false
},
"resellerCustomer" : {
"type" : "boolean",
"default" : false
},
"id" : {
"type" : "string"
}
}
},
"SmsConfiguration" : {
"type" : "object",
"properties" : {
"apiSecretKey" : {
"type" : "string"
},
"apiSharedKey" : {
"type" : "string"
},
"endpoint" : {
"type" : "string"
},
"senderNumber" : {
"type" : "string"
},
"vendor" : {
"type" : "string",
"enum" : [ "TWILIO" ]
}
}
},
"TaskResults" : {
"type" : "object",
"properties" : {
"values" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
},
"DeploymentLoadBalancerDescription" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"deploymentId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"firewallIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"label" : {
"type" : "string"
},
"loadBalancerId" : {
"type" : "integer",
"format" : "int64"
},
"machineImageId" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"product" : {
"$ref" : "#/definitions/VMProduct"
},
"scope" : {
"type" : "string",
"enum" : [ "GLOBAL", "REGION", "DATA_CENTER" ]
},
"type" : {
"type" : "string",
"enum" : [ "VM_DYNAMIC", "VM_STATIC", "CLOUD" ]
}
}
},
"NetworkDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"accountId" : {
"type" : "integer",
"format" : "int64"
},
"customerBillingId" : {
"type" : "integer",
"format" : "int64"
},
"cloudId" : {
"type" : "integer",
"format" : "int64"
},
"regionId" : {
"type" : "integer",
"format" : "int64"
},
"zoneId" : {
"type" : "integer",
"format" : "int64"
},
"hasShadow" : {
"type" : "boolean",
"default" : false
},
"shadowState" : {
"type" : "string"
},
"shadowDescription" : {
"type" : "string"
},
"agentCommunicatesOverPublicInternet" : {
"type" : "boolean",
"default" : false
},
"dataCenterId" : {
"type" : "integer",
"format" : "int64"
},
"details" : {
"$ref" : "#/definitions/NetworkDetails"
},
"dnsServers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"flat" : {
"type" : "boolean",
"default" : false
},
"networkAddress" : {
"type" : "string"
},
"networkId" : {
"type" : "integer",
"format" : "int64"
},
"networkType" : {
"type" : "string",
"enum" : [ "STANDARD", "OVERLAY" ]
},
"ntpServers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"providerNetworkId" : {
"type" : "string"
},
"publiclyAddressable" : {
"type" : "boolean",
"default" : false
},
"resourceLocator" : {
"type" : "string"
},
"subnetsCanBeCreated" : {
"type" : "boolean",
"default" : false
},
"subnetsCanExist" : {
"type" : "boolean",
"default" : false
},
"actions" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Action"
}
},
"billingId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"ConfigurationManagementServiceDescription" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean",
"default" : false
},
"budgetId" : {
"type" : "integer",
"format" : "int64"
},
"customerId" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"owningGroupId" : {
"type" : "integer",
"format" : "int64"
},
"owningUserId" : {
"type" : "integer",
"format" : "int64"
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"lastModifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"details" : {
"$ref" : "#/definitions/ConfigurationManagementServiceDetails"
},
"propertiesAsJson" : {
"type" : "string"
},
"serviceId" : {
"type" : "integer",
"format" : "int64"
},
"serviceEndpoint" : {
"type" : "string"
},
"systemId" : {
"type" : "integer",
"format" : "int64"
},
"publicService" : {
"type" : "boolean",
"default" : false
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment